home *** CD-ROM | disk | FTP | other *** search
/ The Fatted Calf / The Fatted Calf.iso / Applications / Misc / NXSpice / NXSpice.app / helpdir / NUTMEG.txt < prev    next >
Text File  |  1991-06-24  |  143KB  |  3,921 lines
  1. SUBJECT: main
  2. TITLE: Help System
  3. TEXT:      This is the nutmeg _h_e_l_p system.  To chose a subtopic or
  4. TEXT:      see-also topic, click a mouse button in the appropriate box
  5. TEXT:      below,  or type the number of the topic that you want if you
  6. TEXT:      are using an ASCII terminal.
  7. TEXT: 
  8. SUBTOPIC: SPICE:analyses NUTMEG:arguments SPICE:batchmode
  9. SUBTOPIC: NUTMEG:bugs NUTMEG:caveats NUTMEG:commands
  10. SUBTOPIC: SPICE:convergence NUTMEG:cshstuff SPICE:elements
  11. SUBTOPIC: SPICE:examples NUTMEG:expressions NUTMEG:graphics
  12. SUBTOPIC: NUTMEG:hpux NUTMEG:input SPICE:models
  13. SUBTOPIC: SPICE:options NUTMEG:pc NUTMEG:proglang
  14. SUBTOPIC: NUTMEG:refs NUTMEG:sconvert SPICE:spice
  15. SUBTOPIC: NUTMEG:variables NUTMEG:vms
  16.  
  17. SUBJECT: arguments
  18. TITLE: Command Line Arguments
  19. TEXT: 
  20. TEXT:      GNutmeg Hand Gspice Htake the following command line options.
  21. TEXT: H     Additional arguments are taken to be circuit files in the
  22. TEXT: H     case of GspiceH, or raw data files to be loaded in the case of
  23. TEXT: H     GnutmegH.
  24. TEXT: H
  25. TEXT: 
  26. SUBTOPIC: NUTMEG:dash SPICE:dashb SPICE:dashi
  27. SUBTOPIC: NUTMEG:dashn NUTMEG:dasho SPICE:dashq
  28. SUBTOPIC: NUTMEG:dashr SPICE:dashs NUTMEG:dasht
  29.  
  30. SUBJECT: dash
  31. TITLE: -
  32. TEXT: 
  33. TEXT:      G-    HDon't try load a rawfile (Gnutmeg Honly).  The default
  34. TEXT: H          rawfile name is GrawspiceH, which will be loaded in if no
  35. TEXT: H          other filenames are given on the command line.
  36. TEXT: H
  37. TEXT: 
  38.  
  39. SUBJECT: dashn
  40. TITLE: -n
  41. TEXT: 
  42. TEXT:      G-n   HDon't try to source the file ".spiceinit" upon startup.
  43. TEXT: H          Normally the program tries to find the file in the
  44. TEXT: H          current directory, and if it is not found then it
  45. TEXT: H          checks in the user's home directory.
  46. TEXT: H
  47. TEXT: 
  48.  
  49. SUBJECT: dasho
  50. TITLE: -o
  51. TEXT: 
  52. TEXT:      G-o outfile
  53. TEXT: H          HOpen the given file for output, instead of sending out-
  54. TEXT: H          put to the terminal.
  55. TEXT: H
  56. TEXT: 
  57.  
  58. SUBJECT: dashr
  59. TITLE: -r
  60. TEXT: 
  61. TEXT:      G-r   HUse the named file for dumping data if this is Gspice Hin
  62. TEXT: H          batch mode, and use it as the default rawfile for the
  63. TEXT: H          Gwrite Hcommand.  Note that if the program is GnutmegH,
  64. TEXT: H          this option will not cause the named file to be loaded.
  65. TEXT: H
  66. TEXT: 
  67.  
  68. SUBJECT: dasht
  69. TITLE: -t
  70. TEXT: 
  71. TEXT:      G-t term
  72. TEXT: H          HThe program is being run on a terminal with MFB name
  73. TEXT: H          GtermH.  (MFB is the graphics package used for dumb
  74. TEXT: H          graphics terminals.) Note that MFB names are often not
  75. TEXT: H          the same as _t_e_r_m_c_a_p names, so this option is needed to
  76. TEXT: H          override the TERM environment variable.
  77. TEXT: H
  78. TEXT: 
  79.  
  80. SUBJECT: bugs
  81. TITLE: Bugs
  82. TEXT: 
  83. TEXT:      The label entry facilities are very primitive - after all,
  84. TEXT: H     Gnutmeg Hisn't a graphics editor (yet).  You must be careful
  85. TEXT: H     to type very slowly when entering labels -- Gnutmeg Hchecks
  86. TEXT: H     the GX Hevent queue once every second, and can get very con-
  87. TEXT: H     fused if characters arrive faster than that.
  88. TEXT: H
  89. TEXT:      When defining aliases like
  90. TEXT: H
  91. TEXT:           Galias Hpdb Gplot dbH( '!:1' - '!:2' )
  92. TEXT: H
  93. TEXT:      you must be careful to quote the argument list substitutions
  94. TEXT: H     in this manner. If you quote the whole argument it might not
  95. TEXT: H     work properly.
  96. TEXT: H
  97. TEXT:      In a user-defined function, the arguments cannot be part of
  98. TEXT: H     a name that uses the _p_l_o_t._v_e_c syntax.  I.e,
  99. TEXT: H
  100. TEXT:           Gdefine Hpoke(duck) GcosH(tran1.duck)
  101. TEXT: H
  102. TEXT:      won't do the right thing.
  103. TEXT: H
  104. TEXT:      If you type Gplot all allH, or otherwise use a wildcard refer-
  105. TEXT: H     ence for one plot twice in a command, bad things will hap-
  106. TEXT: H     pen.
  107. TEXT: H
  108. TEXT:      The Gasciiplot Hcommand doesn't deal with log scales or most
  109. TEXT: H     of the keywords that Gplot Hrecognises.  Don't expect it to
  110. TEXT: H     ever do smith charts.
  111. TEXT: H
  112. TEXT:      When a new vector is created with the G[ ] Hand G[[ ]] Hopera-
  113. TEXT: H     tions, a subset of the old scale should also be created for
  114. TEXT: H     it that includes the same elements, so that it may be plot-
  115. TEXT: H     ted, etc.
  116. TEXT: H
  117. TEXT:      When substitutions are done with the ^_o_l_d^_n_e_w^ syntax, there
  118. TEXT: H     may be no spaces in either _o_l_d or _n_e_w.
  119. TEXT: H
  120. TEXT:      If the user erases text in an X plot window by typing spaces
  121. TEXT: H     over it, and then dumps it to a file with the Ghardcopy Hcom-
  122. TEXT: H     mand, the erased text will re-appear.
  123. TEXT: H
  124. TEXT:      If an X plot window is created and then resized to be much
  125. TEXT: H     larger, or the Ghardcopy Hcommand is used to dump it to a file
  126. TEXT: H     and it is then printed on a device with much higher resolu-
  127. TEXT: H     tion than the X display, the "automatic manhattanization"
  128. TEXT: H     feature (i.e, round-off error) will cause the picture to
  129. TEXT: H     look very funny.
  130. TEXT: H
  131. TEXT:      SPICE3 will recognise all the notations used in SPICE2 G.plot
  132. TEXT: H     Hcards, and will translate Gvp(1) Hinto Gph(v(1))H, and so forth.
  133. TEXT: H     However, if there are spaces in these names it won't work.
  134. TEXT: H     Hence Gv(1, 2) Hand G(-.5, .5) Haren't recognised.
  135. TEXT: H
  136. TEXT:      The "nutmeg programming language" should serve as a lesson
  137. TEXT: H     on why a language designer should understand that he is
  138. TEXT: H     creating a language before he has already implemented it.
  139. TEXT: H
  140. TEXT:      If a command is implemented as a script, the Ghelp Hcommand
  141. TEXT: H     won't say anything about it and it won't be available for
  142. TEXT: H     command and argument completion.
  143. TEXT: H
  144. TEXT:      If you plot an expression containing the function GrndH, and
  145. TEXT: H     then zoom in or out in the window, you will get different
  146. TEXT: H     random numbers in the new window.
  147. TEXT: H
  148. TEXT:      Global filename expansion has some problems.  In particular,
  149. TEXT: H     G*/* Hmay give a result of "No match" when there is a file in
  150. TEXT: H     the current directory.
  151. TEXT: H
  152. TEXT: 
  153. SEEALSO: NUTMEG:caveats
  154.  
  155. SUBJECT: caveats
  156. TITLE: Caveats
  157. TEXT: 
  158. TEXT:      Often the names of terminals recognised by GMFB Hare different
  159. TEXT: H     from those in /etc/termcap. Thus you may have to reset your
  160. TEXT: H     terminal type with the command
  161. TEXT: H
  162. TEXT:           Gset Hterm = _t_e_r_m_n_a_m_e
  163. TEXT: H
  164. TEXT:      where _t_e_r_m_n_a_m_e is the name in the Gmfbcap Hfile.
  165. TEXT: H
  166. TEXT:      The Ghardcopy Hcommand is useless on VMS and other systems
  167. TEXT: H     without the UNIX Gplot Hcommand, unless the user has a program
  168. TEXT: H     that understands _p_l_o_t(_5) format.
  169. TEXT: H
  170. TEXT:      GSpice Hinput files specified on the command line are read in
  171. TEXT: H     before theG.spiceinit Hfile is read. Thus if you define
  172. TEXT: H     aliases there that you call in a Gspice Hsource file mentioned
  173. TEXT: H     on the command line, they won't be recognised.
  174. TEXT: H
  175. TEXT:      If you interrupt a simulation and then load in a new deck,
  176. TEXT: H     or Gsetcirc Hto a different one, and run a simulation on that,
  177. TEXT: H     it will not be possible to Gresume Hthe old simulation.
  178. TEXT: H
  179. TEXT:      Don't trust command completion too much.
  180. TEXT: H
  181. TEXT: 
  182. SEEALSO: NUTMEG:bugs
  183.  
  184. SUBJECT: commands
  185. TITLE: Built-in Commands
  186. TEXT: 
  187. TEXT:      When a command is typed, it is interpreted as one of several
  188. TEXT: H     things.  First, it may be an alias, in which case the line
  189. TEXT: H     is replaced with the result after alias substitution, and
  190. TEXT: H     the line is re-parsed.  Second, it may be a pre-defined com-
  191. TEXT: H     mand, in which case it is executed (see below for a list of
  192. TEXT: H     available commands).  Third, it may be the name of a circuit
  193. TEXT: H     file, in which case it is loaded (if the program is GspiceH)
  194. TEXT: H     as if with a Gsource Hcommand.  Fourth, it may be the name of
  195. TEXT: H     a command script - Gnutmeg Hsearches the current Gsourcepath
  196. TEXT: H     Hfor the file and executes it when it is found.  The effect
  197. TEXT: H     of this is identical to the effect of Gsouce fileH, except
  198. TEXT: H     that the variables Gargc Hand Gargv Hare set.  Fifth, it may be
  199. TEXT: H     an assignment statement, which consists of a vector name, an
  200. TEXT: H     G= Hsymbol, and an expression (see the syntax for the Glet Hcom-
  201. TEXT: H     mand), in which case it is executed as if it were preceeded
  202. TEXT: H     by the word GletH.  Finally, it may be a UNIX command, in
  203. TEXT: H     which case if the variable Gunixcom His set, it is executed as
  204. TEXT: H     though it were typed to the shell.  (This is only available
  205. TEXT: H     on BSD UNIX systems.)
  206. TEXT: H
  207. TEXT:      The following is a list of the built-in commands available.
  208. TEXT: H     Some may be command scripts - the only difference between a
  209. TEXT: H     built-in and a script that is visible to the user is that a
  210. TEXT: H     script will not be mentioned in the quick help summary, and
  211. TEXT: H     will not be visible to command completion.
  212. TEXT: H
  213. TEXT: 
  214. SUBTOPIC: SPICE:ac NUTMEG:alias NUTMEG:alter
  215. SUBTOPIC: NUTMEG:asciiplot SPICE:aspice NUTMEG:break
  216. SUBTOPIC: NUTMEG:bug NUTMEG:cd NUTMEG:cdump
  217. SUBTOPIC: NUTMEG:compose NUTMEG:continue NUTMEG:cross
  218. SUBTOPIC: SPICE:dc NUTMEG:define NUTMEG:deftype
  219. SUBTOPIC: SPICE:delete NUTMEG:destroy NUTMEG:diff
  220. SUBTOPIC: NUTMEG:display NUTMEG:dowhile NUTMEG:dump
  221. SUBTOPIC: NUTMEG:echo NUTMEG:edit NUTMEG:else
  222. SUBTOPIC: NUTMEG:end NUTMEG:foreach NUTMEG:fourier
  223. SUBTOPIC: NUTMEG:goto NUTMEG:hardcopy NUTMEG:help
  224. SUBTOPIC: NUTMEG:historycomm NUTMEG:if SPICE:iplot
  225. SUBTOPIC: NUTMEG:jobs NUTMEG:label NUTMEG:let
  226. SUBTOPIC: NUTMEG:linearize SPICE:listing NUTMEG:load
  227. SUBTOPIC: NUTMEG:oldhelp SPICE:op NUTMEG:plot
  228. SUBTOPIC: NUTMEG:print SPICE NUTMEG:quit
  229. SUBTOPIC: NUTMEG:rehash NUTMEG:repeat SPICE:reset
  230. SUBTOPIC: SPICE:resume SPICE:rspice SPICE:run
  231. SUBTOPIC: NUTMEG:rusage SPICE:save NUTMEG:set
  232. SUBTOPIC: SPICE:setcirc NUTMEG:setplot NUTMEG:settype
  233. SUBTOPIC: NUTMEG:shell NUTMEG:shift NUTMEG:show
  234. SUBTOPIC: NUTMEG:source NUTMEG:state NUTMEG:status
  235. SUBTOPIC: SPICE:step SPICE:stop NUTMEG:strcmp
  236. SUBTOPIC: SPICE:trace SPICE:tran NUTMEG:unalias
  237. SUBTOPIC: NUTMEG:undefine NUTMEG:unlet NUTMEG:unset
  238. SUBTOPIC: NUTMEG:version NUTMEG:while NUTMEG:write
  239.  
  240. SEEALSO: NUTMEG:proglang
  241.  
  242. SUBJECT: alias
  243. TITLE: alias
  244. TEXT: 
  245. TEXT:      Galias H[ _w_o_r_d ] [ _t_e_x_t ]
  246. TEXT: H          Cause _w_o_r_d to be aliased to _t_e_x_t.  Whenever a command
  247. TEXT: H          line beginning with _w_o_r_d is typed, _t_e_x_t is substituted.
  248. TEXT: H          Arguments are either appended to the end, or substi-
  249. TEXT: H          tuted in if history characters are present in the _t_e_x_t.
  250. TEXT: H          See the description of "C-shell like features".
  251. TEXT: H
  252. TEXT: 
  253. SEEALSO: NUTMEG:unalias
  254. SEEALSO: NUTMEG:aliases
  255.  
  256. SUBJECT: alter
  257. TITLE: alter
  258. TEXT: 
  259. TEXT:      Galter H_a_r_g_s...
  260. TEXT: H          Change the parameters of a device while a simulation is
  261. TEXT: H          in progress.  This command is not yet implemented.
  262. TEXT: H
  263. TEXT: 
  264. SEEALSO: NUTMEG:show
  265.  
  266. SUBJECT: asciiplot
  267. TITLE: asciiplot
  268. TEXT: 
  269. TEXT:      Gasciiplot H_p_l_o_t_a_r_g_s
  270. TEXT: H          Produce a line printer plot of the vectors.  See the
  271. TEXT: H          description of the Gplot Hcommand for the syntax of _p_l_o_-
  272. TEXT: H          _t_a_r_g_s.  The plot is sent to the standard output, so you
  273. TEXT: H          can put it into a file with Gasciiplot H_a_r_g_s G> H_f_i_l_e.  The
  274. TEXT: H          variables Gwidth, height, Hand Gnobreak Hdetermine the
  275. TEXT: H          width and height of the plot, and whether there are
  276. TEXT: H          page breaks, respectively. Note that you will have
  277. TEXT: H          problems if you try to Gasciiplot Hsomething with an X-
  278. TEXT: H          scale that isn't monotonic (i.e, something like
  279. TEXT: H          _s_i_n(_T_I_M_E) ), because Gasciiplot Huses a simple-minded
  280. TEXT: H          sort of linear interpolation.  Also, most of the key-
  281. TEXT: H          words that Gplot Hrecognises aren't used by GasciiplotH.
  282. TEXT: H
  283. TEXT: 
  284. SEEALSO: NUTMEG:plot
  285. SEEALSO: NUTMEG:hardcopy
  286. SEEALSO: NUTMEG:width
  287. SEEALSO: NUTMEG:height
  288. SEEALSO: NUTMEG:noasciiplotvalue
  289. SEEALSO: NUTMEG:nobreak
  290. SEEALSO: NUTMEG:expressions
  291.  
  292. SUBJECT: break
  293. TITLE: break
  294. TEXT: 
  295. TEXT:      Gbreak H[ _n_u_m_b_e_r ]
  296. TEXT: H          If there is a Gwhile, dowhile, Hor Gforeach Hblock enclos-
  297. TEXT: H          ing this statement, control passes out of the block.
  298. TEXT: H          Otherwise an error results.  If a _n_u_m_b_e_r is given, that
  299. TEXT: H          number of enclosing blocks are exited.
  300. TEXT: H
  301. TEXT: 
  302. SEEALSO: NUTMEG:proglang
  303.  
  304. SUBJECT: bug
  305. TITLE: bug
  306. TEXT: 
  307. TEXT:      Gbug  HThis sends a bug report to the maintainer of SPICE3, if
  308. TEXT: H          it has been compiled with the BUGADDR option.
  309. TEXT: H
  310. TEXT: 
  311.  
  312. SUBJECT: cd
  313. TITLE: cd
  314. TEXT: 
  315. TEXT:      Gcd H[ _d_i_r_e_c_t_o_r_y ]
  316. TEXT: H          Change the current working directory to _d_i_r_e_c_t_o_r_y, or
  317. TEXT: H          the user's home directory if none is given.
  318. TEXT: H
  319. TEXT: 
  320.  
  321. SUBJECT: cdump
  322. TITLE: cdump
  323. TEXT: 
  324. TEXT:      Gcdump
  325. TEXT: H          HThis is a debugging command for printing out the con-
  326. TEXT: H          tents of the currently active control structures.
  327. TEXT: H
  328. TEXT: 
  329. SEEALSO: NUTMEG:proglang
  330.  
  331. SUBJECT: compose
  332. TITLE: compose
  333. TEXT: 
  334. TEXT:      Gcompose H_v_e_c_n_a_m_e [ _p_a_r_a_m = _v_a_l_u_e ] ...
  335. TEXT: H          or
  336. TEXT: H
  337. TEXT:      Gcompose H_v_e_c_n_a_m_e Gvalues H_v_a_l_u_e ...
  338. TEXT: H          Both forms of this command create a new vector called
  339. TEXT: H          _v_e_c_n_a_m_e.  In the first form, the values in the vector
  340. TEXT: H          are determined by the parameters given.  In the second
  341. TEXT: H          form, the given values are used to form the vector.
  342. TEXT: H
  343. TEXT:           The first form of this command is currently unimple-
  344. TEXT: H          mented.  Currently, in order to get any desired vector
  345. TEXT: H          one may use the Glet Hcommand with various functions such
  346. TEXT: H          as Gvector(), rnd(), Hand so on.  GCompose His intended to
  347. TEXT: H          be a more convenient method of constructing such vec-
  348. TEXT: H          tors.
  349. TEXT: H
  350. TEXT: 
  351. SEEALSO: NUTMEG:let
  352.  
  353. SUBJECT: continue
  354. TITLE: continue
  355. TEXT: 
  356. TEXT:      Gcontinue H[ _n_u_m_b_e_r ]
  357. TEXT: H          If there is a Gwhile, dowhile, Hor Gforeach Hblock enclos-
  358. TEXT: H          ing this statement, control returns to the beginning of
  359. TEXT: H          that block.  If there is no such enclosing block, an
  360. TEXT: H          error results.  If a _n_u_m_b_e_r is given, control is passed
  361. TEXT: H          to the beginning of the _n_u_m_b_e_r'th enclosing block.
  362. TEXT: H
  363. TEXT: 
  364. SEEALSO: NUTMEG:proglang
  365.  
  366. SUBJECT: cross
  367. TITLE: cross
  368. TEXT: 
  369. TEXT:      Gcross H_v_e_c_n_a_m_e _n_u_m_b_e_r [ _s_o_u_r_c_e ] ...
  370. TEXT: H          A new vector is constructed, with name _v_e_c_n_a_m_e and
  371. TEXT: H          values consisting of the _n_u_m_b_e_r'th element of each of
  372. TEXT: H          the _s_o_u_r_c_e vectors.  This is a rather awkward way to
  373. TEXT: H          deal with multi-dimensional data - a more general
  374. TEXT: H          method is being developed.
  375. TEXT: H
  376. TEXT: 
  377.  
  378. SUBJECT: define
  379. TITLE: define
  380. TEXT: 
  381. TEXT:      Gdefine H_f_u_n_c_t_i_o_n(_a_r_g, ...) _e_x_p_r_e_s_s_i_o_n
  382. TEXT: H          Define the macro with the name _f_u_n_c_t_i_o_n and arguments
  383. TEXT: H          _a_r_g, ... to be _e_x_p_r_e_s_s_i_o_n, which may involve the argu-
  384. TEXT: H          ments. When the function is later used, the arguments
  385. TEXT: H          it is given are substituted for the formal arguments
  386. TEXT: H          when it is parsed.  If _e_x_p_r_e_s_s_i_o_n is not present, any
  387. TEXT: H          definitions for _f_u_n_c_t_i_o_n are printed, and if there are
  388. TEXT: H          no arguments to _d_e_f_i_n_e then all currently active defin-
  389. TEXT: H          itions are printed. Note that you may have different
  390. TEXT: H          functions defined with the same name but different ari-
  391. TEXT: H          ties.  Some useful definitions (which are part of the
  392. TEXT: H          default environment) are:
  393. TEXT: H
  394. TEXT:          Gdefine maxH(x,y) (x > y) * x + (x <= y) * y
  395. TEXT: H         Gdefine minH(x,y) (x < y) * x + (x >= y) * y
  396. TEXT: H
  397. TEXT: 
  398. SEEALSO: NUTMEG:undefine
  399. SEEALSO: NUTMEG:expressions
  400.  
  401. SUBJECT: deftype
  402. TITLE: deftype
  403. TEXT: 
  404. TEXT:      Gdeftype v H_t_y_p_e_n_a_m_e [ _a_b_b_r_e_v ]
  405. TEXT: H          or
  406. TEXT: H
  407. TEXT:      Gdeftype p H_p_l_o_t_t_y_p_e [ _p_a_t_t_e_r_n ] ...
  408. TEXT: H          This command is intended to make Gnutmeg Heasier to use
  409. TEXT: H          with simulators other than SPICE3.  It is only a tem-
  410. TEXT: H          porary facility, however.  The first form defines a new
  411. TEXT: H          type for vectors.  The _t_y_p_e_n_a_m_e may then be used as a
  412. TEXT: H          vector type specification in a rawfile, and will be
  413. TEXT: H          used for the Gdisplay Hcommand to indicate the type.  If
  414. TEXT: H          an _a_b_b_r_e_v is given, values of that type can be named
  415. TEXT: H          _a_b_b_r_e_v(_s_o_m_e_t_h_i_n_g) where _s_o_m_e_t_h_i_n_g is the name given in
  416. TEXT: H          the rawfile (and _s_o_m_e_t_h_i_n_g doesn't contain
  417. TEXT: H          parentheses).  The second form defines a plot type.
  418. TEXT: H          The (one word) name for a plot with any of the _p_a_t_t_e_r_ns
  419. TEXT: H          present in its plot type name as given in the raw file
  420. TEXT: H          will be _p_l_o_t_t_y_p_e<_n_u_m>, where <_n_u_m> is a positive
  421. TEXT: H          integer incremented every time a rawfile is read or a
  422. TEXT: H          new plot is defined.
  423. TEXT: H
  424. TEXT: 
  425.  
  426. SUBJECT: destroy
  427. TITLE: destroy
  428. TEXT:      destroy [ _p_l_o_t_n_a_m_e ... ] [ all ]
  429. TEXT:           Throw away the data in the named plot and reclaim the
  430. TEXT:           storage space.  This can be necessary if a lot of large
  431. TEXT:           simulations are being done.  spice should warn the user
  432. TEXT:           if the size of the program is approaching the maximum
  433. TEXT:           allowable size (within about 90%), but it is advisable
  434. TEXT:           to run the rusage command occasionally if running out
  435. TEXT:           of space is a possibility.  If the argument to destroy
  436. TEXT:           is all, all plots except the constant plot will be
  437. TEXT:           thrown away.  It is not possible to destroy the con-
  438. TEXT:           stant plot.  If no argument is given the current plot
  439. TEXT:           is destroyed.
  440. TEXT: 
  441. SEEALSO: NUTMEG:setplot
  442. SEEALSO: NUTMEG:rusage
  443.  
  444. SUBJECT: diff
  445. TITLE: diff
  446. TEXT: 
  447. TEXT:      Gdiff H_p_l_o_t_1 _p_l_o_t_2 [ _v_e_c_n_a_m_e ] ...
  448. TEXT: H          Compare the vectors in the named _p_l_o_ts and print out
  449. TEXT: H          any values which differ significantly in corresponding
  450. TEXT: H          vectors in the two plots.  If no _v_e_c_n_a_m_es are men-
  451. TEXT: H          tioned, all vectors in the plots are compared, and if
  452. TEXT: H          one or more names are given only those vectors are com-
  453. TEXT: H          pared.  The variables GabstolH, GreltolH, and Gvntol Hare
  454. TEXT: H          used to determine if two values are "significantly"
  455. TEXT: H          different.  (See the SPICE3 User's Guide for details of
  456. TEXT: H          these variables.)
  457. TEXT: H
  458. TEXT: 
  459. SEEALSO: NUTMEG:abstol
  460. SEEALSO: NUTMEG:vntol
  461. SEEALSO: NUTMEG:reltol
  462.  
  463. SUBJECT: display
  464. TITLE: display
  465. TEXT: 
  466. TEXT:      Gdisplay H[ _v_e_c_n_a_m_e ] ...
  467. TEXT: H          List the names, types and lengths of the vectors
  468. TEXT: H          defined in the current plot, and whether the vector is
  469. TEXT: H          real or complex.  If one or more _v_e_c_a_m_es are given the
  470. TEXT: H          list is restricted to those vectors.  Additional infor-
  471. TEXT: H          mation is also given:  if there is a minimum or maximum
  472. TEXT: H          value for the vector defined, this is listed (see the
  473. TEXT: H          manual page for Gsconvert Hfor a definition of the
  474. TEXT: H          rawfile format and the manner in which this and the
  475. TEXT: H          rest of the per-vector parameters are defined), if
  476. TEXT: H          there is a default grid type or a default plot type,
  477. TEXT: H          they are mentioned, and if there is a default color or
  478. TEXT: H          a default scale for the vector it is noted.  Addition-
  479. TEXT: H          ally, one vector in the plot will have the notation
  480. TEXT: H          G[default scale] Happended - this vector will be used as
  481. TEXT: H          the x-scale for the Gplot Hcommand if none is given or is
  482. TEXT: H          the vectors named have no default scales of their own.
  483. TEXT: H          A better description of these parameters is given with
  484. TEXT: H          the description of the Gplot Hcommand.
  485. TEXT: H
  486. TEXT: 
  487.  
  488. SUBJECT: dowhile
  489. TITLE: dowhile
  490. TEXT: 
  491. TEXT:      Gdowhile H_c_o_n_d_i_t_i_o_n
  492. TEXT: H          This line, together with a matching Gend Hstatement,
  493. TEXT: H          defines a block of commands that are executed while the
  494. TEXT: H          _c_o_n_d_i_t_i_o_n remains true.  (The _c_o_n_d_i_t_i_o_n is an expres-
  495. TEXT: H          sion which is considered true if it evaluates to a
  496. TEXT: H          non-0 value.)  Unlike the Gwhile Hstatement, the test is
  497. TEXT: H          done at the bottom of the loop.
  498. TEXT: H
  499. TEXT: 
  500. SEEALSO: NUTMEG:proglang
  501.  
  502. SUBJECT: dump
  503. TITLE: dump
  504. TEXT: 
  505. TEXT:      Gdump HThis command causes a debugging print of the internal
  506. TEXT: H          data structures used by the simulator.  It is not
  507. TEXT: H          guaranteed to provide any useful information. (Gspice
  508. TEXT: H          Honly)
  509. TEXT: H
  510. TEXT: 
  511.  
  512. SUBJECT: echo
  513. TITLE: echo
  514. TEXT: 
  515. TEXT:      Gecho H[ G-n H] [ _s_t_u_f_f ] ...
  516. TEXT: H          Print the _s_t_u_f_f on the standard output.  If the G-n Hflag
  517. TEXT: H          is given, don't append a newline.
  518. TEXT: H
  519. TEXT: 
  520.  
  521. SUBJECT: edit
  522. TITLE: edit
  523. TEXT: 
  524. TEXT:      Gedit H[ _f_i_l_e_n_a_m_e ]
  525. TEXT: H          Print the current circuit definition into a file, call
  526. TEXT: H          up the editor on that file and allow the user to modify
  527. TEXT: H          it, and then read it back in, replacing the original
  528. TEXT: H          definition. If a Gfilename His given, then edit that file
  529. TEXT: H          and Gsource Hit, making the circuit the current one.
  530. TEXT: H
  531. TEXT: 
  532.  
  533. SUBJECT: else
  534. TITLE: else
  535. TEXT: 
  536. TEXT:      Gelse HPart of an Gif-else Hblock.  See the description of the
  537. TEXT: H          Gif Hstatement.
  538. TEXT: H
  539. TEXT: 
  540. SEEALSO: NUTMEG:proglang
  541.  
  542. SUBJECT: end
  543. TITLE: end
  544. TEXT: 
  545. TEXT:      Gend  HThis statement terminates a block.  It is an error for
  546. TEXT: H          an Gend Hto appear without a matching Gbegin, if, while,
  547. TEXT: H          repeat, foreach, Hor Gdowhile Hstatement.
  548. TEXT: H
  549. TEXT: 
  550. SEEALSO: NUTMEG:proglang
  551.  
  552. SUBJECT: foreach
  553. TITLE: foreach
  554. TEXT: 
  555. TEXT:      Gforeach H_v_a_r  [ _v_a_l_u_e ] ...
  556. TEXT: H          This statement opens a block which will be executed
  557. TEXT: H          once for each _v_a_l_u_e given.  Each time through, the _v_a_r
  558. TEXT: H          will be set to sucessive _v_a_l_u_es.  After the loop is
  559. TEXT: H          exited it will have the last value that was assigned to
  560. TEXT: H          it.
  561. TEXT: H
  562. TEXT: 
  563. SEEALSO: NUTMEG:proglang
  564.  
  565. SUBJECT: fourier
  566. TITLE: fourier
  567. TEXT: 
  568. TEXT:      Gfourier H_f_u_n_d_a_m_e_n_t_a_l__f_r_e_q_u_e_n_c_y [ _v_a_l_u_e ] ...
  569. TEXT: H          Does a fourier analysis of each of the given values,
  570. TEXT: H          using the first 10 multiples of the fundamental fre-
  571. TEXT: H          quency (or the first _n_f_r_e_q_s, if that variable is set).
  572. TEXT: H          The _v_a_l_u_es may be any valid expression.  They are
  573. TEXT: H          interpolated onto a fixed-spaced grid with the number
  574. TEXT: H          of points given by the Gfourgridsize Hvariable, or 200 if
  575. TEXT: H          it is not set.  The interpolation will be of degree
  576. TEXT: H          Gpolydegree Hif that variable is set, or 1.  If Gpolyde-
  577. TEXT: H          gree His 0, then no interpolation will be done.  This
  578. TEXT: H          command is executed when a G.four Hline is present in the
  579. TEXT: H          input file and Gspice His being run in batch mode.
  580. TEXT: H
  581. TEXT: 
  582. SEEALSO: NUTMEG:fourgridsize
  583. SEEALSO: NUTMEG:nfreqs
  584.  
  585. SUBJECT: goto
  586. TITLE: goto
  587. TEXT: 
  588. TEXT:      Ggoto H_l_a_b_e_l
  589. TEXT: H          If there is a Glabel Hstatement in an enclosing block
  590. TEXT: H          defining the _l_a_b_e_l, transfer execution to the statement
  591. TEXT: H          following it.  Note that if Ggoto His used outside of a
  592. TEXT: H          block, the label must be above the GgotoH.  There is a
  593. TEXT: H          Gbegin Hmacro pre-defined as _i_f _1 which may be used if
  594. TEXT: H          forward label references are required outside of a loop
  595. TEXT: H          construct.
  596. TEXT: H
  597. TEXT: 
  598. SEEALSO: NUTMEG:proglang
  599.  
  600. SUBJECT: hardcopy
  601. TITLE: hardcopy
  602. TEXT: 
  603. TEXT:      Ghardcopy H[ _f_i_l_e_n_a_m_e ] [ _p_l_o_t _a_r_g_u_m_e_n_t_s ]
  604. TEXT: H          This command has a syntax identical to that of the Gplot
  605. TEXT: H          Hcommand, except for a _f_i_l_e_n_a_m_e in which to put the plot
  606. TEXT: H          image.  If no plot arguments are given, the user will
  607. TEXT: H          be prompted to select a window which will be dumped
  608. TEXT: H          into the file (if he is using a graphics system with
  609. TEXT: H          windows such as X).  If no _f_i_l_e_n_a_m_e is given a tem-
  610. TEXT: H          porary file will be used.  If the Ghcopydev Hvariable is
  611. TEXT: H          defined, the file will be printed using the command
  612. TEXT: H          "lpr -g -P_h_c_o_p_y_d_e_v file", and if a temporary file was
  613. TEXT: H          used, it will be removed.  This is likely to work only
  614. TEXT: H          on a UNIX system.  The format of the plot image file is
  615. TEXT: H          given in the UNIX manual page for Gplot(5)H, and may be
  616. TEXT: H          plotted on a terminal with the UNIX Gplot Hprogram.
  617. TEXT: H
  618. TEXT: 
  619. SEEALSO: NUTMEG:plot
  620. SEEALSO: NUTMEG:asciiplot
  621. SEEALSO: NUTMEG:hcopydev
  622.  
  623. SUBJECT: help
  624. TITLE: help
  625. TEXT:      help [ _t_o_p_i_c ] ...
  626. TEXT:           This is an interactive graphical help browser.  Its
  627. TEXT:           operation should be largely self-explanatory.  The user
  628. TEXT:           is presented with a window (if he is using the X win-
  629. TEXT:           dows system) or a screenful of information.
  630. TEXT: 
  631. TEXT:           In the X version, there will be a number of "buttons"
  632. TEXT:           which the user can click the mouse in, each of which
  633. TEXT:           correspond to a sub-topic of the topic discussed in the
  634. TEXT:           window, or a "see also" topic which is related to the
  635. TEXT:           current one.  If the user clicks the mouse in one of
  636. TEXT:           these buttons, a new window will be created overlapping
  637. TEXT:           the old one, which contains the information on the
  638. TEXT:           requested topic.  Each window also contains buttons in
  639. TEXT:           the upper right-hand corner:  Delete Window will cause
  640. TEXT:           the window and all others that are its "descendants" to
  641. TEXT:           go away; Quit Help will cause all the windows to disap-
  642. TEXT:           pear and help system to be exited; and possibly Next
  643. TEXT:           Page and Prev Page, which allow the user to scroll
  644. TEXT:           around the text if there is more data than will fit on
  645. TEXT:           a reasonable screen.
  646. TEXT: 
  647. TEXT:           If X is unavailable, the information will be paged as
  648. TEXT:           in the _m_o_r_e program.  At the end of the text there will
  649. TEXT:           be a menu of the available sub-topics and see-alsos.
  650. TEXT: 
  651. TEXT:           If for some reason the help directory is unavailable,
  652. TEXT:           the oldhelp command will be used.
  653. TEXT: 
  654. SEEALSO: NUTMEG:X
  655. SEEALSO: NUTMEG:helpregfont
  656. SEEALSO: NUTMEG:helpboldfont
  657. SEEALSO: NUTMEG:helpitalicfont
  658. SEEALSO: NUTMEG:helptitlefont
  659. SEEALSO: NUTMEG:helpbuttonfont
  660. SEEALSO: NUTMEG:helpbuttonstyle
  661. SEEALSO: NUTMEG:helpinitxpos
  662. SEEALSO: NUTMEG:helpinitypos
  663. SEEALSO: NUTMEG:oldhelp
  664.  
  665. SUBJECT: historycomm
  666. TITLE: history command
  667. TEXT: 
  668. TEXT:      Ghistory H[ G-r H] [ _n_u_m_b_e_r ] ...
  669. TEXT: H          Print out the last _n_u_m_b_e_r commands typed by the user,
  670. TEXT: H          or all the commands saved if there are no arguments.
  671. TEXT: H          The number of commands saved is determined by the value
  672. TEXT: H          of the Ghistory Hvariable.  If the G-r Hflag is given, the
  673. TEXT: H          list is printed in reverse order.
  674. TEXT: H
  675. TEXT: 
  676. SEEALSO: NUTMEG:historyvar
  677. SEEALSO: NUTMEG:historysub
  678.  
  679. SUBJECT: if
  680. TITLE: if
  681. TEXT: 
  682. TEXT:      Gif H_c_o_n_d_i_t_i_o_n
  683. TEXT: H          This statement defines a block to be executed if the
  684. TEXT: H          _c_o_n_d_i_t_i_o_n is true.  See the section on the command
  685. TEXT: H          language for more details.
  686. TEXT: H
  687. TEXT: 
  688. SEEALSO: NUTMEG:proglang
  689.  
  690. SUBJECT: jobs
  691. TITLE: jobs
  692. TEXT: 
  693. TEXT:      Gjobs HPrint out a summary of all the simulations which have
  694. TEXT: H          been started with the Gaspice Hcommand.
  695. TEXT: H
  696. TEXT: 
  697. SEEALSO: SPICE:aspice
  698.  
  699. SUBJECT: label
  700. TITLE: label
  701. TEXT: 
  702. TEXT:      Glabel H_l_a_b_e_l_n_a_m_e
  703. TEXT: H          This defines a label which can be used as an argument
  704. TEXT: H          to GgotoH.
  705. TEXT: H
  706. TEXT: 
  707. SEEALSO: NUTMEG:proglang
  708.  
  709. SUBJECT: let
  710. TITLE: let
  711. TEXT: 
  712. TEXT:      Glet H_v_e_c_n_a_m_e G= H_e_x_p_r
  713. TEXT: H          Create a vector with name _v_e_c_n_a_m_e and value given by
  714. TEXT: H          the expression _e_x_p_r.  None of the vector options such
  715. TEXT: H          as default scale, color, etc that are read from the
  716. TEXT: H          rawfile are preserved when a vector is created in this
  717. TEXT: H          manner.
  718. TEXT: H
  719. TEXT: 
  720. SEEALSO: NUTMEG:expressions
  721. SEEALSO: NUTMEG:compose
  722.  
  723. SUBJECT: linearize
  724. TITLE: linearize
  725. TEXT: 
  726. TEXT:      Glinearize H[ _v_e_c_n_a_m_e ] ...
  727. TEXT: H          The purpose of this command is to force data from a
  728. TEXT: H          transient analysis to conform to a linear scale.  Due
  729. TEXT: H          to the algorithm used to determine the timesteps used,
  730. TEXT: H          the time scale may not be linear.  If no _v_e_c_n_a_m_es are
  731. TEXT: H          given, all the vectors in the current plot are copied
  732. TEXT: H          to a new plot which becomes the current plot, and their
  733. TEXT: H          data is interpolated onto a linear time scale.  If one
  734. TEXT: H          or more vectors are named, only those vectors are
  735. TEXT: H          copied.   The variable Gpolydegree Hdetermines how the
  736. TEXT: H          interpolation is done.  Note that this command is only
  737. TEXT: H          available in GspiceH, and the current plot must
  738. TEXT: H          correspond to the current circuit (otherwise the wrong
  739. TEXT: H          values for the start, step, and stop times may be
  740. TEXT: H          used).
  741. TEXT: H
  742. TEXT: 
  743.  
  744. SUBJECT: load
  745. TITLE: load
  746. TEXT: 
  747. TEXT:      Gload H[ _f_i_l_e_n_a_m_e ] ...
  748. TEXT: H          Loads the data in either binary or ascii format from
  749. TEXT: H          the files named. The default filename is GrawspiceH, or
  750. TEXT: H          the argument to the G-r Hcommand line option if one was
  751. TEXT: H          given.  The last plot in the file becomes the current
  752. TEXT: H          plot.  A description of the rawfile format is given in
  753. TEXT: H          the manual page for GsconvertH.
  754. TEXT: H
  755. TEXT: 
  756. SEEALSO: NUTMEG:write
  757.  
  758. SUBJECT: oldhelp
  759. TITLE: oldhelp
  760. TEXT:      help [ all ] [ _c_o_m_m_a_n_d_n_a_m_e ] ...
  761. TEXT:           A brief helpful message is printed, followed by one-
  762. TEXT:           line descriptions of all the commands named, or all
  763. TEXT:           commands if all was given.  If there are no arguments
  764. TEXT:           only a few useful commands are described.  This command
  765. TEXT:           is available in case for some reason the documentation
  766. TEXT:           browser is broken.
  767. TEXT: 
  768. SEEALSO: NUTMEG:help
  769.  
  770. SUBJECT: plot
  771. TITLE: plot
  772. TEXT: 
  773. TEXT:      Gplot [ _e_x_p_r ... [ Gvs H_x-_e_x_p_r ] ] H[ _o_p_t_i_o_n_s ] ...
  774. TEXT: H          Plot the values of the expressions on the graphics dev-
  775. TEXT: H          ice, if there is one.  For each set of expressions that
  776. TEXT: H          is followed by a Gvs H_x-_e_x_p_r clause, all those vectors
  777. TEXT: H          are plotted with the _x-_e_x_p_r for a scale.  Multiple sets
  778. TEXT: H          of expressions with different x-scales may be given in
  779. TEXT: H          this manner.  The available options are listed below.
  780. TEXT: H          Note that options must appear after expressions.
  781. TEXT: H
  782. TEXT: 
  783. SUBTOPIC: NUTMEG:combplot NUTMEG:lingrid NUTMEG:linplot
  784. SUBTOPIC: NUTMEG:loglog NUTMEG:nogrid NUTMEG:nointerp
  785. SUBTOPIC: NUTMEG:pointplot NUTMEG:samep
  786. SUBTOPIC: NUTMEG:title NUTMEG:xcompress
  787. SUBTOPIC: NUTMEG:xdelta NUTMEG:xindices NUTMEG:xlabel
  788. SUBTOPIC: NUTMEG:xlimit NUTMEG:xlog NUTMEG:ydelta
  789. SUBTOPIC: NUTMEG:ylabel NUTMEG:ylimit NUTMEG:ylog
  790.  
  791. SEEALSO: NUTMEG:hardcopy
  792. SEEALSO: NUTMEG:asciiplot
  793. SEEALSO: NUTMEG:expressions
  794. SEEALSO: NUTMEG:graphics
  795. SEEALSO: NUTMEG:device
  796. SEEALSO: NUTMEG:term
  797. SEEALSO: NUTMEG:color
  798. SEEALSO: NUTMEG:geometry
  799. SEEALSO: NUTMEG:dontplot
  800.  
  801. SUBJECT: combplot
  802. TITLE: combplot
  803. TEXT: 
  804. TEXT:      Gcombplot
  805. TEXT: H          HUse a comb plot instead of connected points.  Each
  806. TEXT: H          point is connected to the bottom of the screen by a
  807. TEXT: H          line.
  808. TEXT: H
  809. TEXT: 
  810.  
  811. SUBJECT: lingrid
  812. TITLE: lingrid
  813. TEXT: 
  814. TEXT:      Glingrid
  815. TEXT: H          HUse a linear grid.  This is the default grid type.
  816. TEXT: H
  817. TEXT: 
  818.  
  819. SUBJECT: linplot
  820. TITLE: linplot
  821. TEXT: 
  822. TEXT:      Glinplot
  823. TEXT: H          HPlot data as points connected by lines.  This is the
  824. TEXT: H          default.
  825. TEXT: H
  826. TEXT: 
  827.  
  828. SUBJECT: loglog
  829. TITLE: loglog
  830. TEXT: 
  831. TEXT:      Gloglog
  832. TEXT: H          HUse a log-log grid.
  833. TEXT: H
  834. TEXT: 
  835.  
  836. SUBJECT: nogrid
  837. TITLE: nogrid
  838. TEXT:      nogrid
  839. TEXT:           Don't plot a grid.  The data will be plotted on a
  840. TEXT:           linear scale and only the border lines at the bottom
  841. TEXT:           and left sides of the screen will be drawn.
  842. TEXT: 
  843.  
  844. SUBJECT: nointerp
  845. TITLE: nointerp
  846. TEXT:      nointerp
  847. TEXT:           Normally asciiplot interpolates data onto a linear
  848. TEXT:           scale before plotting it.  If this option is given this
  849. TEXT:           won't be done - each line will correspond to one data
  850. TEXT:           point as generated by the simulation.
  851. TEXT: 
  852. SEEALSO: NUTMEG:asciiplot
  853.  
  854. SUBJECT: pointplot
  855. TITLE: pointplot
  856. TEXT: 
  857. TEXT:      Gpointplot
  858. TEXT: H          HPlot data points as unconnected points.  Each sucessive
  859. TEXT: H          expression is plotted with a different character to
  860. TEXT: H          mark the points.  The characters used may be changed by
  861. TEXT: H          setting the variable GpointcharsH.
  862. TEXT: H
  863. TEXT: 
  864.  
  865. SUBJECT: polar
  866. TITLE: polar
  867. TEXT: 
  868. TEXT:      Gpolar
  869. TEXT: H          HUse a polar grid instead of a rectangular grid.
  870. TEXT: H
  871. TEXT: 
  872. SEEALSO: NUTMEG:smith
  873.  
  874. SUBJECT: samep
  875. TITLE: samep
  876. TEXT: 
  877. TEXT:      Gsamep
  878. TEXT: H          HIf this option appears anywhere on the command line,
  879. TEXT: H          all the options used in the last Gplot Hcommand are used
  880. TEXT: H          for the current one, overriding options on the current
  881. TEXT: H          line if they appear on both lines.
  882. TEXT: H
  883. TEXT: 
  884.  
  885. SUBJECT: smith
  886. TITLE: smith
  887. TEXT: 
  888. TEXT:      Gsmith
  889. TEXT: H          HUse a smith grid instead of a rectangular or polar
  890. TEXT: H          grid.  There are a few problems, the major ones being
  891. TEXT: H          that the grid is centered around the x-axis, and that
  892. TEXT: H          too few labels are printed on the perimeter of the plot
  893. TEXT: H          area.
  894. TEXT: H
  895. TEXT: 
  896.  
  897. SUBJECT: title
  898. TITLE: title
  899. TEXT: 
  900. TEXT:      Gtitle H_s_t_r_i_n_g
  901. TEXT: H          The string will be used as the title printed near the
  902. TEXT: H          bottom of the screen instead of the title of the plot
  903. TEXT: H          that includes the first vector mentioned on the line
  904. TEXT: H          that has one.
  905. TEXT: H
  906. TEXT: 
  907.  
  908. SUBJECT: xcompress
  909. TITLE: xcompress
  910. TEXT: 
  911. TEXT:      Gxcompress H_v_a_l_u_e
  912. TEXT: H          Plot only one out of every _v_a_l_u_e points in each of the
  913. TEXT: H          vectors.
  914. TEXT: H
  915. TEXT: 
  916.  
  917. SUBJECT: xdelta
  918. TITLE: xdelta
  919. TEXT: 
  920. TEXT:      Gxdelta H_v_a_l_u_e
  921. TEXT: H          This value is used as the spacing between grid lines on
  922. TEXT: H          the x-axis.
  923. TEXT: H
  924. TEXT: 
  925.  
  926. SUBJECT: xindices
  927. TITLE: xindices
  928. TEXT: 
  929. TEXT:      Gxindices H_l_o_w_e_r _u_p_p_e_r
  930. TEXT: H          Only data points with indices between _l_o_w_e_r and _u_p_p_e_r
  931. TEXT: H          are plotted.  _u_p_p_e_r must be greater or equal to _l_o_w_e_r.
  932. TEXT: H
  933. TEXT: 
  934.  
  935. SUBJECT: xlabel
  936. TITLE: xlabel
  937. TEXT: 
  938. TEXT:      Gxlabel H_s_t_r_i_n_g
  939. TEXT: H          The string is used as the label for the x-axis, instead
  940. TEXT: H          of the name of the first scale used.
  941. TEXT: H
  942. TEXT: 
  943.  
  944. SUBJECT: xlimit
  945. TITLE: xlimit
  946. TEXT: 
  947. TEXT:      Gxlimit H_l_o_w_e_r _u_p_p_e_r
  948. TEXT: H          The plot area in the x-direction is restricted to lie
  949. TEXT: H          between _l_o_w_e_r and _u_p_p_e_r.  The area actually used may be
  950. TEXT: H          somewhat larger to provide nicely spaced grid lines,
  951. TEXT: H          however.
  952. TEXT: H
  953. TEXT: 
  954.  
  955. SUBJECT: xlog
  956. TITLE: xlog
  957. TEXT: 
  958. TEXT:      Gxlog HUse a log scale for the x-axis and a linear scale for
  959. TEXT: H          the y-axis.
  960. TEXT: H
  961. TEXT: 
  962.  
  963. SUBJECT: ydelta
  964. TITLE: ydelta
  965. TEXT: 
  966. TEXT:      Gydelta H_v_a_l_u_e
  967. TEXT: H          Use the _v_a_l_u_e as the spacing between the grid lines on
  968. TEXT: H          the y-axis.
  969. TEXT: H
  970. TEXT: 
  971.  
  972. SUBJECT: ylabel
  973. TITLE: ylabel
  974. TEXT: 
  975. TEXT:      Gylabel H_s_t_r_i_n_g
  976. TEXT: H          Use the _s_t_r_i_n_g as the label for the y-axis.  (By
  977. TEXT: H          default none is printed.)
  978. TEXT: H
  979. TEXT: 
  980.  
  981. SUBJECT: ylimit
  982. TITLE: ylimit
  983. TEXT: 
  984. TEXT:      Gylimit H_l_o_w_e_r _u_p_p_e_r
  985. TEXT: H          Limit the plot area in the y-direction to lie between
  986. TEXT: H          _l_o_w_e_r and _u_p_p_e_r.  It may be expanded slightly to allow
  987. TEXT: H          for nicely spaced grid lines.
  988. TEXT: H
  989. TEXT: 
  990.  
  991. SUBJECT: ylog
  992. TITLE: ylog
  993. TEXT: 
  994. TEXT:      Gylog HUse a log scale for the y-axis and a linear scale for
  995. TEXT: H          the x-axis.
  996. TEXT: H
  997. TEXT: 
  998.  
  999. SUBJECT: print
  1000. TITLE: print
  1001. TEXT: 
  1002. TEXT:      Gprint H[ Gcol H] [ Gline H] [ _e_x_p_r ] ...
  1003. TEXT: H          Print the values of the given expressions to the stan-
  1004. TEXT: H          dard output.  If Gcol His specified, print the values in
  1005. TEXT: H          columns, with the scale in the leftmost column on each
  1006. TEXT: H          page.  If Gline His specified, print the value of each
  1007. TEXT: H          expression on one line (or more if needed). If all
  1008. TEXT: H          expressions have a length of 1, the default style is
  1009. TEXT: H          GlineH, otherwise Gcol His the default.
  1010. TEXT: H
  1011. TEXT: 
  1012.  
  1013. SUBJECT: quit
  1014. TITLE: quit
  1015. TEXT: 
  1016. TEXT:      Gquit HExit the program.  If there are circuits that are in
  1017. TEXT: H          the middle of a simulation, or plots that have not been
  1018. TEXT: H          saved in a file, the user is reminded of this and asked
  1019. TEXT: H          to confirm.  (The variable Gnoaskquit Hdisables this.)
  1020. TEXT: H
  1021. TEXT: 
  1022. SEEALSO: NUTMEG:noaskquit
  1023.  
  1024. SUBJECT: rehash
  1025. TITLE: rehash
  1026. TEXT: 
  1027. TEXT:      Grehash
  1028. TEXT: H          HRecalculate the internal hash tables used when looking
  1029. TEXT: H          up UNIX commands, and make all UNIX commands in the
  1030. TEXT: H          user's PATH available for command completion.  This is
  1031. TEXT: H          a no-op unless you have the Gunixcom Hvariable set.
  1032. TEXT: H
  1033. TEXT: 
  1034. SEEALSO: NUTMEG:unixcomcomm
  1035. SEEALSO: NUTMEG:unixcom
  1036.  
  1037. SUBJECT: repeat
  1038. TITLE: repeat
  1039. TEXT: 
  1040. TEXT:      Grepeat H[ _n_u_m_b_e_r ]
  1041. TEXT: H          Execute the statements in the block defined by this
  1042. TEXT: H          line and the corresponding Gend Hstatement _n_u_m_b_e_r times,
  1043. TEXT: H          or indefinitely if no _n_u_m_b_e_r is given.
  1044. TEXT: H
  1045. TEXT: 
  1046. SEEALSO: NUTMEG:proglang
  1047.  
  1048. SUBJECT: rusage
  1049. TITLE: rusage
  1050. TEXT: 
  1051. TEXT:      Grusage H[ Gall H] [ _r_e_s_o_u_r_c_e ] ...
  1052. TEXT: H          Print out various resource usage statistics.  If Gall His
  1053. TEXT: H          given as an argument, all the information available is
  1054. TEXT: H          printed.  If no arguments are given, only total time
  1055. TEXT: H          and space usage are printed.  Otherwise, information
  1056. TEXT: H          corresponding to each of the arguments is printed.  The
  1057. TEXT: H          resource types recognised are given below.  Note that
  1058. TEXT: H          many of them are available only with GspiceH, and some
  1059. TEXT: H          only available with UNIX.
  1060. TEXT: H
  1061. TEXT: 
  1062. SUBTOPIC: NUTMEG:accept NUTMEG:elapsed NUTMEG:faults
  1063. SUBTOPIC: NUTMEG:loadtime NUTMEG:lutime NUTMEG:rejected
  1064. SUBTOPIC: NUTMEG:solvetime NUTMEG:space NUTMEG:time
  1065. SUBTOPIC: NUTMEG:totaltime NUTMEG:totiter NUTMEG:traniter
  1066. SUBTOPIC: NUTMEG:tranpoints NUTMEG:transolvetime NUTMEG:trantime
  1067.  
  1068.  
  1069. SUBJECT: accept
  1070. TITLE: accept
  1071. TEXT: 
  1072. TEXT:      Gaccept
  1073. TEXT: H          HThe number of accepted time points.
  1074. TEXT: H
  1075. TEXT: 
  1076.  
  1077. SUBJECT: elapsed
  1078. TITLE: elapsed
  1079. TEXT: 
  1080. TEXT:      Gelapsed
  1081. TEXT: H          HThe total amount of time elapsed since the last Grusage
  1082. TEXT: H          elapsed Hcommand.
  1083. TEXT: H
  1084. TEXT: 
  1085.  
  1086. SUBJECT: faults
  1087. TITLE: faults
  1088. TEXT: 
  1089. TEXT:      Gfaults
  1090. TEXT: H          HThe number of page faults caused by the program so far.
  1091. TEXT: H
  1092. TEXT: 
  1093.  
  1094. SUBJECT: loadtime
  1095. TITLE: loadtime
  1096. TEXT: 
  1097. TEXT:      Gloadtime
  1098. TEXT: H          HThe amount of time spent loading the matrix.
  1099. TEXT: H
  1100. TEXT: 
  1101.  
  1102. SUBJECT: lutime
  1103. TITLE: lutime
  1104. TEXT: 
  1105. TEXT:      Glutime
  1106. TEXT: H          HThe amount of time spent doing transient L-U decomposi-
  1107. TEXT: H          tion.
  1108. TEXT: H
  1109. TEXT: 
  1110.  
  1111. SUBJECT: rejected
  1112. TITLE: rejected
  1113. TEXT: 
  1114. TEXT:      Grejected
  1115. TEXT: H          HThe number of rejected time points.
  1116. TEXT: H
  1117. TEXT: 
  1118.  
  1119. SUBJECT: solvetime
  1120. TITLE: solvetime
  1121. TEXT: 
  1122. TEXT:      Gsolvetime
  1123. TEXT: H          HThe amount of time spent solving the matrix.
  1124. TEXT: H
  1125. TEXT: 
  1126.  
  1127. SUBJECT: space
  1128. TITLE: space
  1129. TEXT: 
  1130. TEXT:      Gspace
  1131. TEXT: H          HThe amount of data space currently used by the program.
  1132. TEXT: H
  1133. TEXT: 
  1134.  
  1135. SUBJECT: time
  1136. TITLE: time
  1137. TEXT: 
  1138. TEXT:      Gtime HThe amount of time spent so far doing the current
  1139. TEXT: H          analysis.
  1140. TEXT: H
  1141. TEXT: 
  1142.  
  1143. SUBJECT: totaltime
  1144. TITLE: totaltime
  1145. TEXT: 
  1146. TEXT:      Gtotaltime
  1147. TEXT: H          HThe total amount of time spent by the program since it
  1148. TEXT: H          was started.
  1149. TEXT: H
  1150. TEXT: 
  1151.  
  1152. SUBJECT: totiter
  1153. TITLE: totiter
  1154. TEXT: 
  1155. TEXT:      Gtotiter
  1156. TEXT: H          HThe total number of iterations.
  1157. TEXT: H
  1158. TEXT: 
  1159.  
  1160. SUBJECT: traniter
  1161. TITLE: traniter
  1162. TEXT: 
  1163. TEXT:      Gtraniter
  1164. TEXT: H          HThe number of transient iterations.
  1165. TEXT: H
  1166. TEXT: 
  1167.  
  1168. SUBJECT: tranpoints
  1169. TITLE: tranpoints
  1170. TEXT: 
  1171. TEXT:      Gtranpoints
  1172. TEXT: H          HThe number of transient time points.
  1173. TEXT: H
  1174. TEXT: 
  1175.  
  1176. SUBJECT: transolvetime
  1177. TITLE: transolvetime
  1178. TEXT: 
  1179. TEXT:      Gtransolvetime
  1180. TEXT: H          HThe amount transient solve time.
  1181. TEXT: H
  1182. TEXT: 
  1183.  
  1184. SUBJECT: trantime
  1185. TITLE: trantime
  1186. TEXT: 
  1187. TEXT:      Gtrantime
  1188. TEXT: H          HThe total transient time so far.
  1189. TEXT: H
  1190. TEXT: 
  1191.  
  1192. SUBJECT: set
  1193. TITLE: set
  1194. TEXT: 
  1195. TEXT:      Gset H[ _v_a_r_n_a_m_e [ G= H_v_a_l_u_e ] ] ...
  1196. TEXT: H          The Gset Hcommand allows the user to examine and set
  1197. TEXT: H          variables.  In the first form, the names and values of
  1198. TEXT: H          all the variables are printed.  Some may be prefixed
  1199. TEXT: H          with a '*', which means that they are associated with
  1200. TEXT: H          the current plot, and will change when the current plot
  1201. TEXT: H          changes.  Others may be prefixed by a '+', which means
  1202. TEXT: H          that they are associated with the current circuit.  If
  1203. TEXT: H          a variable is defined which has the same name as one
  1204. TEXT: H          associated with the current plot or circuit, it takes
  1205. TEXT: H          precedence for printing with the Gset Hcommand and $
  1206. TEXT: H          expansion, but it will not change the value used by the
  1207. TEXT: H          circuit.  Some variables are read-only and may not be
  1208. TEXT: H          changed by the user.  This is not indicated by the Gset
  1209. TEXT: H          Hcommand, however.
  1210. TEXT: H
  1211. TEXT:           In the second form, where a _v_a_r_n_a_m_e is given, that
  1212. TEXT: H          variable is either set (with a 'true' boolean value),
  1213. TEXT: H          or given the _v_a_l_u_e specified.  A value may be a number,
  1214. TEXT: H          a string, or a list of values.  A string is anything
  1215. TEXT: H          which isn't a list or parsable as a number, and a list
  1216. TEXT: H          is surrounded by parentheses.  The variables which have
  1217. TEXT: H          any meaning to Gnutmeg Hor Gspice Hare listed in the GVARI-
  1218. TEXT: H          ABLES Hsection of the manual.
  1219. TEXT: H
  1220. TEXT: 
  1221. SEEALSO: NUTMEG:unset
  1222. SEEALSO: NUTMEG:variables
  1223. SEEALSO: NUTMEG:variablesub
  1224.  
  1225. SUBJECT: setplot
  1226. TITLE: setplot
  1227. TEXT: 
  1228. TEXT:      Gsetplot H[ _p_l_o_t_n_a_m_e ]
  1229. TEXT: H          Set the current plot to the plot with the given name,
  1230. TEXT: H          or if no name is given, prompt the user with a menu.
  1231. TEXT: H          Note that Gsetplot His a command script - it is possible
  1232. TEXT: H          to change the current plot by setting the variable Gcur-
  1233. TEXT: H          plotH.
  1234. TEXT: H
  1235. TEXT: 
  1236. SEEALSO: NUTMEG:curplot
  1237. SEEALSO: NUTMEG:plotvars
  1238.  
  1239. SUBJECT: settype
  1240. TITLE: settype
  1241. TEXT: 
  1242. TEXT:      Gsettype H_t_y_p_e [ _v_e_c_t_o_r ] ...
  1243. TEXT: H          Change the type of the named vectors to _t_y_p_e.  Type
  1244. TEXT: H          names can be found in the manual page for GsconvertH, or
  1245. TEXT: H          they may be defined with the Gdeftype Hcommand.
  1246. TEXT: H
  1247. TEXT: 
  1248.  
  1249. SUBJECT: shell
  1250. TITLE: shell
  1251. TEXT: 
  1252. TEXT:      Gshell H[ _c_o_m_m_a_n_d ] ...
  1253. TEXT: H          Fork a shell, or execute the arguments as a command to
  1254. TEXT: H          the shell.  This command works with both UNIX and VMS.
  1255. TEXT: H
  1256. TEXT: 
  1257. SEEALSO: NUTMEG:unixcom
  1258.  
  1259. SUBJECT: shift
  1260. TITLE: shift
  1261. TEXT: 
  1262. TEXT:      Gshift H[ _v_a_r_n_a_m_e ] [ _n_u_m_b_e_r ]
  1263. TEXT: H          If _v_a_r_n_a_m_e is the name of a list variable, it is
  1264. TEXT: H          shifted to the left by _n_u_m_b_e_r elements. (I.e, the
  1265. TEXT: H          _n_u_m_b_e_r leftmost elements are removed.)  The default
  1266. TEXT: H          _v_a_r_n_a_m_e is GargvH, and the default _n_u_m_b_e_r is 1.
  1267. TEXT: H
  1268. TEXT: 
  1269. SEEALSO: NUTMEG:variables
  1270.  
  1271. SUBJECT: show
  1272. TITLE: show
  1273. TEXT: 
  1274. TEXT:      Gshow H[ _d_e_v_n_a_m_e ] ... G: H[ _p_a_r_m_n_a_m_e ] ...
  1275. TEXT: H          Print the named device parameters of the requested dev-
  1276. TEXT: H          ices.  Either the device name list or the parameter
  1277. TEXT: H          name list may be GallH, and the device names may contain
  1278. TEXT: H          the G*, ?, Hand G[] Hwildcard characters.  For lists of the
  1279. TEXT: H          parameters that the various devices recognise, see the
  1280. TEXT: H          SPICE3 User's Guide.
  1281. TEXT: H
  1282. TEXT: 
  1283. SEEALSO: NUTMEG:alter
  1284.  
  1285. SUBJECT: source
  1286. TITLE: source
  1287. TEXT: 
  1288. TEXT:      Gsource H_f_i_l_e_n_a_m_e ...
  1289. TEXT: H          The Gsource Hcommand has two functions - it loads a cir-
  1290. TEXT: H          cuit description from a file or set of files, and it
  1291. TEXT: H          reads commands to be executed from a file.  Since com-
  1292. TEXT: H          mands may be imbedded in circuit files, the two are
  1293. TEXT: H          treated in the same manner.  Command lines must be sur-
  1294. TEXT: H          rounded by the lines G.control Hand G.endc Hin the file, or
  1295. TEXT: H          prefixed by G*# Hin order to be recognised as commands.
  1296. TEXT: H          (The exception to this rule is the file G.spiceinitH,
  1297. TEXT: H          which is known to contain only commands.)  In either
  1298. TEXT: H          case, the first line in the file is ignored, so a com-
  1299. TEXT: H          mand script must begin with a blank line and then a
  1300. TEXT: H          G.control Hline.
  1301. TEXT: H
  1302. TEXT: 
  1303. SEEALSO: NUTMEG:sourcepath
  1304.  
  1305. SUBJECT: state
  1306. TITLE: state
  1307. TEXT: 
  1308. TEXT:      Gstate
  1309. TEXT: H          HIt's not clear what this command should do.  Currently
  1310. TEXT: H          it prints the name and status of the current curcuit.
  1311. TEXT: H
  1312. TEXT: 
  1313.  
  1314. SUBJECT: status
  1315. TITLE: status
  1316. TEXT: 
  1317. TEXT:      Gstatus
  1318. TEXT: H          HPrint out a summary of all the Gtrace, stop, save, Hand
  1319. TEXT: H          Giplot Hcommands that are active.  The numbers given may
  1320. TEXT: H          be used with the Gdelete Hcommand to de-activate the
  1321. TEXT: H          trace.
  1322. TEXT: H
  1323. TEXT: 
  1324. SEEALSO: SPICE:delete
  1325. SEEALSO: SPICE:step
  1326. SEEALSO: SPICE:iplot
  1327. SEEALSO: SPICE:stop
  1328.  
  1329. SUBJECT: step
  1330. TITLE: step
  1331. TEXT: 
  1332. TEXT:      Gstep H[ _n_u_m_b_e_r ]
  1333. TEXT: H          Single-step the simulation, or let it run for _n_u_m_b_e_r
  1334. TEXT: H          time steps if a _n_u_m_b_e_r is given.
  1335. TEXT: H
  1336. TEXT: 
  1337. SEEALSO: SPICE:iplot
  1338. SEEALSO: SPICE:stop
  1339. SEEALSO: NUTMEG:status
  1340. SEEALSO: SPICE:delete
  1341.  
  1342. SUBJECT: stop
  1343. TITLE: stop
  1344. TEXT: 
  1345. TEXT:      Gstop H[ Gafter H_n_u_m ] [ Gwhen H_v_a_l_1 _o_p _v_a_l_2 ] ...
  1346. TEXT: H          Create a breakpoint.  If an Gafter Hclause is given, the
  1347. TEXT: H          simulation will stop after _n_u_m points.  If a Gwhen
  1348. TEXT: H          Hclause is included, at each point, the _v_a_l_1 _o_p _v_a_l_2
  1349. TEXT: H          condition will be checked, and if it is true, the simu-
  1350. TEXT: H          lation will stop.  If more than one Gwhen Hor Gafter
  1351. TEXT: H          Hclause is put on one line, the conjunction of the con-
  1352. TEXT: H          ditions is checked.  The _v_a_ls may be either constants
  1353. TEXT: H          or node names.  The possible _o_ps are:
  1354. TEXT: H             Geq   Hor   G=    H(equal to)
  1355. TEXT: H             Gne   Hor   G<>   H(not equal to)
  1356. TEXT: H             Ggt   Hor   G>    H(greater than)
  1357. TEXT: H             Glt   Hor   G<    H(less than)
  1358. TEXT: H             Gge   Hor   G>=   H(greater than or equal to)
  1359. TEXT: H             Gle   Hor   G<=   H(less than or equal to)
  1360. TEXT: H
  1361. TEXT:           Note that for this command, < and > do not denote IO
  1362. TEXT: H          redirection.
  1363. TEXT: H
  1364. TEXT: 
  1365. SEEALSO: SPICE:step
  1366. SEEALSO: SPICE:iplot
  1367. SEEALSO: SPICE:delete
  1368. SEEALSO: NUTMEG:status
  1369.  
  1370. SUBJECT: strcmp
  1371. TITLE: strcmp
  1372. TEXT: 
  1373. TEXT:      Gstrcmp H_v_a_r_n_a_m_e _s_t_r_i_n_g_1 _s_t_r_i_n_g_2
  1374. TEXT: H          The value of _v_a_r_n_a_m_e is set to a number that is greater
  1375. TEXT: H          than, equal to, or less than 0 according as _s_t_r_i_n_g_1 is
  1376. TEXT: H          lexically before, equal to, or after _s_t_r_i_n_g_2.  This
  1377. TEXT: H          command is a very bad thing, but there seems to be no
  1378. TEXT: H          other way to do string comparisons given the restric-
  1379. TEXT: H          tions of the Gnutmeg Hcommand language.
  1380. TEXT: H
  1381. TEXT: 
  1382.  
  1383. SUBJECT: unalias
  1384. TITLE: unalias
  1385. TEXT: 
  1386. TEXT:      Gunalias H[ _w_o_r_d ] ...
  1387. TEXT: H          Removes any aliases associated with all the _w_o_r_ds.  The
  1388. TEXT: H          argument may be "*", in which case all aliases are
  1389. TEXT: H          deleted.
  1390. TEXT: H
  1391. TEXT: 
  1392. SEEALSO: NUTMEG:alias
  1393. SEEALSO: NUTMEG:aliases
  1394.  
  1395. SUBJECT: undefine
  1396. TITLE: undefine
  1397. TEXT: 
  1398. TEXT:      Gundefine H[ _w_o_r_d ] ...
  1399. TEXT: H          Remove all the macro functions defined for the _w_o_r_ds.
  1400. TEXT: H          If the argument is "*", then all macro functions are
  1401. TEXT: H          deleted.  Note that all functions with the given names
  1402. TEXT: H          are removed, so there is no way to delete a function
  1403. TEXT: H          with a particular arity without deleting all functions
  1404. TEXT: H          with that name.
  1405. TEXT: H
  1406. TEXT: 
  1407. SEEALSO: NUTMEG:define
  1408. SEEALSO: NUTMEG:expressions
  1409.  
  1410. SUBJECT: unlet
  1411. TITLE: unlet
  1412. TEXT: 
  1413. TEXT:      Gunlet H[ _v_e_c_n_a_m_e ] ...
  1414. TEXT: H          All the named vectors are removed from the current
  1415. TEXT: H          plot.  If you Gunlet Ha vector which is the default scale
  1416. TEXT: H          (e.g. GTIMEH), a random remaining vector will become the
  1417. TEXT: H          default scale.
  1418. TEXT: H
  1419. TEXT: 
  1420. SEEALSO: NUTMEG:let
  1421.  
  1422. SUBJECT: unset
  1423. TITLE: unset
  1424. TEXT: 
  1425. TEXT:      Gunset H[ _v_a_r_n_a_m_e ] ...
  1426. TEXT: H          All the named variables are unset.  The argument may be
  1427. TEXT: H          "*", in which case all variables are unset (although
  1428. TEXT: H          this is usually not something that you would want to
  1429. TEXT: H          do).
  1430. TEXT: H
  1431. TEXT: 
  1432. SEEALSO: NUTMEG:set
  1433. SEEALSO: NUTMEG:variablesub
  1434. SEEALSO: NUTMEG:variables
  1435.  
  1436. SUBJECT: version
  1437. TITLE: version
  1438. TEXT: 
  1439. TEXT:      Gversion H[ _v_e_r_s_i_o_n _n_a_m_e ]
  1440. TEXT: H          With no arguments, this command prints out the current
  1441. TEXT: H          version of GspiceH.  If there are arguments, it compares
  1442. TEXT: H          the current version with the given version and prints a
  1443. TEXT: H          warning if they differ.  A Gversion Hcommand is usually
  1444. TEXT: H          included in the rawfile.
  1445. TEXT: H
  1446. TEXT: 
  1447.  
  1448. SUBJECT: while
  1449. TITLE: while
  1450. TEXT: 
  1451. TEXT:      Gwhile H_c_o_n_d_i_t_i_o_n
  1452. TEXT: H          This command defines a block which is executed while
  1453. TEXT: H          the condition is true.
  1454. TEXT: H
  1455. TEXT: 
  1456. SEEALSO: NUTMEG:proglang
  1457.  
  1458. SUBJECT: write
  1459. TITLE: write
  1460. TEXT: 
  1461. TEXT:      Gwrite H[ _f_i_l_e [ _e_x_p_r ] ... ]
  1462. TEXT: H          Writes out the _e_x_p_rs to the file.  First vectors are
  1463. TEXT: H          grouped together by plots, and written out as such.
  1464. TEXT: H          (E.g, if the expression list contained three vectors
  1465. TEXT: H          from one plot and two from another, then two plots will
  1466. TEXT: H          be written, one with three vectors and one with two.)
  1467. TEXT: H          Additionally, if the scale for a vector isn't present,
  1468. TEXT: H          it is automatically written out as well.  The default
  1469. TEXT: H          format is GasciiH, but this may be changed with Gset file-
  1470. TEXT: H          typeH.  The default filename is GrawspiceH, or the argu-
  1471. TEXT: H          ment to the G-r Hflag on the command line, if there was
  1472. TEXT: H          one, and the default expression list is GallH.
  1473. TEXT: H
  1474. TEXT: 
  1475. SEEALSO: NUTMEG:load
  1476. SEEALSO: NUTMEG:expressions
  1477.  
  1478. SUBJECT: cshstuff
  1479. TITLE: C-shell Like Features
  1480. TEXT: 
  1481. TEXT:      Various features are available in the Gnutmeg Hparser which
  1482. TEXT: H     are derived from the user interface of the C-Shell.  These
  1483. TEXT: H     include IO redirection, history substitution, aliases, glo-
  1484. TEXT: H     bal substitution, and command completion.
  1485. TEXT: H
  1486. TEXT: 
  1487. SUBTOPIC: NUTMEG:aliases NUTMEG:ccom NUTMEG:glob
  1488. SUBTOPIC: NUTMEG:historysub NUTMEG:io NUTMEG:quoting
  1489. SUBTOPIC: NUTMEG:semi NUTMEG:unixcomcomm NUTMEG:variablesub
  1490.  
  1491.  
  1492. SUBJECT: aliases
  1493. TITLE: Aliases
  1494. TEXT: 
  1495. TEXT:      After history expansion, if the first word on the command
  1496. TEXT: H     line has been defined as an alias, the text for which it is
  1497. TEXT: H     an alias for is substituted.  The alias may contain refer-
  1498. TEXT: H     ences to the arguments provided on the command line, in
  1499. TEXT: H     which case the appropriate arguments are substituted in.  If
  1500. TEXT: H     there are no such references, any arguments given are
  1501. TEXT: H     appended to the end of the alias text.
  1502. TEXT: H
  1503. TEXT:      In the body if the alias text, any strings of the form
  1504. TEXT: H     G!:H_n_u_m_b_e_r are replaced with the _n_u_m_b_e_r'th argument of the
  1505. TEXT: H     actual command line.  Note that when the alias is defined
  1506. TEXT: H     with the Galias Hcommand, these strings must be quoted to
  1507. TEXT: H     prevent history substitution from replacing the G!H's before
  1508. TEXT: H     the Galias Hcommand can get to them.
  1509. TEXT: H
  1510. TEXT:      Thus the command
  1511. TEXT: H
  1512. TEXT:           Galias Hfoo Gecho H'!:2' '!:1'
  1513. TEXT: H
  1514. TEXT:      Causes "foo bar baz" to be replaced with "echo baz bar".
  1515. TEXT: H     Other G!  Hmodifiers as described in the section on history
  1516. TEXT: H     substitution may also be used, always refering to the actual
  1517. TEXT: H     command line arguments given.
  1518. TEXT: H
  1519. TEXT:      If a command line starts with a backslash (`\') any alias
  1520. TEXT: H     substitution is inhibited.
  1521. TEXT: H
  1522. TEXT: 
  1523. SEEALSO: NUTMEG:alias
  1524. SEEALSO: NUTMEG:unalias
  1525.  
  1526. SUBJECT: ccom
  1527. TITLE: Command Completion
  1528. TEXT: 
  1529. TEXT:      With BSD UNIX, Tenex-style command completion is available.
  1530. TEXT: H     If GEOF H(control-D) is typed after the first character on the
  1531. TEXT: H     line, a list of the commands or possible arguments is
  1532. TEXT: H     printed. (If a control-D is typed as the first character on
  1533. TEXT: H     a line it will exit the program.) If an escape is typed,
  1534. TEXT: H     then the program will try to complete the word being typed
  1535. TEXT: H     based on the choices available, or if there is more than one
  1536. TEXT: H     posibility, it will complete as much as it can.  Command
  1537. TEXT: H     completion knows about commands, most keywords, variable and
  1538. TEXT: H     vector names, file names, and several other types of argu-
  1539. TEXT: H     ments.
  1540. TEXT: H
  1541. TEXT: 
  1542. SEEALSO: SPICE:dashq
  1543.  
  1544. SUBJECT: glob
  1545. TITLE: Global Substitution
  1546. TEXT: 
  1547. TEXT:      The characters `~', `{', and `}' have the same effects as
  1548. TEXT: H     they do in the C-Shell, i.e., home directory and alternative
  1549. TEXT: H     expansion.  The string ~_u_s_e_r at the beginning of a word is
  1550. TEXT: H     replaced by the given user's home directory, or if the first
  1551. TEXT: H     component of the pathname is simply ~, the current user's
  1552. TEXT: H     directory is used.  The string
  1553. TEXT: H     _S_t_u_f_fG{H_S_t_r_i_n_g_1,_S_t_r_i_n_g_2,..._S_t_r_i_n_g_NG}H_M_o_r_e_s_t_u_f_f is replaced by
  1554. TEXT: H     the list of words _S_t_u_f_f_S_t_r_i_n_g_1_M_o_r_e_s_t_u_f_f
  1555. TEXT: H     _S_t_u_f_f_S_t_r_i_n_g_2_M_o_r_e_s_t_u_f_f ...  _S_t_u_f_f_S_t_r_i_n_g_N_M_o_r_e_s_t_u_f_f.  Curly
  1556. TEXT: H     braces may be nested.  It is possible to use the wildcard
  1557. TEXT: H     characters G`*'H, G`?'H, G`['H, and G`]' Hto match filenames, where
  1558. TEXT: H     G`*' Hdenotes 0 or more characters, G`?' Hdenotes one character,
  1559. TEXT: H     and G[] Hdenotes a range of characters, but only if you Gunset
  1560. TEXT: H     noglob Hfirst. This makes them rather useless for typing
  1561. TEXT: H     algebraic expressions, so you should Gset noglob Hagain after
  1562. TEXT: H     you are done with wildcard expansion. Note that the pattern
  1563. TEXT: H     G[^abc] Hwill match all characters _e_x_c_e_p_t G`a', `b', Hand G`c'.
  1564. TEXT: H     HIdeally the parser should know which commands require
  1565. TEXT: H     filename arguments in which positions, and so glob expansion
  1566. TEXT: H     for those words only.
  1567. TEXT: H
  1568. TEXT: 
  1569. SEEALSO: NUTMEG:noglob
  1570.  
  1571. SUBJECT: historysub
  1572. TITLE: History Substitution
  1573. TEXT: 
  1574. TEXT:      History substitutions are prefixed by the character G!H, or at
  1575. TEXT: H     the beginning of a line, the character G^H. Briefly, the
  1576. TEXT: H     string G!! His replaced by the previous command, the string
  1577. TEXT: H     G!H_p_r_e_f_i_x is replaced by the last command with that prefix,
  1578. TEXT: H     the string G!?H_p_a_t_t_e_r_n is replaced by the last command con-
  1579. TEXT: H     taining that pattern, the string G!H_n_u_m_b_e_r is replaced by the
  1580. TEXT: H     event with that number, and G^H_o_l_d_p_a_t_t_e_r_nG^H_n_e_w_p_a_t_t_e_r_n is
  1581. TEXT: H     replaced by the previous command with _n_e_w_p_a_t_t_e_r_n substituted
  1582. TEXT: H     for _o_l_d_p_a_t_t_e_r_n.
  1583. TEXT: H
  1584. TEXT:      Additionally, a G!H_s_t_r_i_n_g sequence may be followed by a modif-
  1585. TEXT: H     ier prefixed with a G:H.  This modifier may select one or more
  1586. TEXT: H     words from the event - :_1 selects the first word, :_2-_5
  1587. TEXT: H     selects the second through the fifth word, :$ selects the
  1588. TEXT: H     last word, and :$-_0 selects all of the words but reverses
  1589. TEXT: H     their order.
  1590. TEXT: H
  1591. TEXT:      Two other G: Hmodifiers are supported: :_p will cause the com-
  1592. TEXT: H     mand to be printed but not executed, and :_s^_o_l_d^_n_e_w will
  1593. TEXT: H     replace the pattern _o_l_d with the pattern _n_e_w.  (The sequence
  1594. TEXT: H     ^_o_l_d^_n_e_w is synonymous with !!:_s^_o_l_d^_n_e_w.)
  1595. TEXT: H
  1596. TEXT:      All the commands typed by the user are saved on the _h_i_s_t_o_r_y
  1597. TEXT: H     _l_i_s_t.  This may be examined with the Ghistory Hcommand, and
  1598. TEXT: H     its maximum length changed by changing the value of the Ghis-
  1599. TEXT: H     tory Hvariable.
  1600. TEXT: H
  1601. TEXT: 
  1602. SEEALSO: NUTMEG:historyvar
  1603.  
  1604. SUBJECT: io
  1605. TITLE: I/O Redirection
  1606. TEXT: 
  1607. TEXT:      The input to or output from commands may be changed from the
  1608. TEXT: H     terminal to a file by including an IO redirection on the
  1609. TEXT: H     command line.  The possible redirections are:
  1610. TEXT: H
  1611. TEXT:      > _f_i_l_e
  1612. TEXT: H          Sends the output of the command into the _f_i_l_e.
  1613. TEXT: H
  1614. TEXT:      >> _f_i_l_e
  1615. TEXT: H          Appends output to the _f_i_l_e or creates it if it doesn't
  1616. TEXT: H          exist.
  1617. TEXT: H
  1618. TEXT:      >& _f_i_l_e
  1619. TEXT: H          Sends both the output and the error messages to the
  1620. TEXT: H          _f_i_l_e.
  1621. TEXT: H
  1622. TEXT:      >>& _f_i_l_e
  1623. TEXT: H          Appends both the output and the error messages to the
  1624. TEXT: H          _f_i_l_e.
  1625. TEXT: H
  1626. TEXT:      < _f_i_l_e
  1627. TEXT: H          Reads input from the _f_i_l_e.
  1628. TEXT: H
  1629. TEXT:      Both an input redirection and an output redirection may be
  1630. TEXT: H     present on a command line.  More than one of each may not be
  1631. TEXT: H     present, however.  IO redirections must be at the end of the
  1632. TEXT: H     command line.
  1633. TEXT: H
  1634. TEXT: 
  1635.  
  1636. SUBJECT: quoting
  1637. TITLE: Quoting
  1638. TEXT: 
  1639. TEXT:      Words may be quoted with the characters " (double quote), '
  1640. TEXT: H     (single quote), and ` (back quote).   A word enclosed by any
  1641. TEXT: H     of these quotes may contain white space.  A string enclosed
  1642. TEXT: H     by double quotes may have further special-character substi-
  1643. TEXT: H     tutions done on it, but it will be considered one word by
  1644. TEXT: H     the program.  A number so quoted is considered a string.  A
  1645. TEXT: H     string enclosed by single quotes also has all its special
  1646. TEXT: H     characters protected.  Thus no glob expansion (*, ?, etc),
  1647. TEXT: H     variable expansion ($), or history substitution (^, !) will
  1648. TEXT: H     be done.  Numbers are still considered numbers though.  A
  1649. TEXT: H     string enclosed by backquotes is considered a command to the
  1650. TEXT: H     shell and is executed, and the output of the command
  1651. TEXT: H     repalaces the text.  Obviously the command should not gen-
  1652. TEXT: H     erate too much output.  This only works on UNIX systems.
  1653. TEXT: H
  1654. TEXT: 
  1655.  
  1656. SUBJECT: semi
  1657. TITLE: Multiple Commands
  1658. TEXT: 
  1659. TEXT:      More than one command may be put on one line, seperated by
  1660. TEXT: H     semicolins (;).  The semicolins must be isolated by white
  1661. TEXT: H     space, however.  Thus a multi-command alias might be written
  1662. TEXT: H     _a_l_i_a_s _w_o_r_d '_c_o_m_m_a_n_d_1 ; _c_o_m_m_a_n_d_2 ; ...'.
  1663. TEXT: H
  1664. TEXT: 
  1665.  
  1666. SUBJECT: unixcomcomm
  1667. TITLE: UNIX Commands
  1668. TEXT: 
  1669. TEXT:      If the variable Gunixcom His set and the operating system is
  1670. TEXT: H     BSD UNIX, commands which are not built-ins are considered
  1671. TEXT: H     UNIX commands and executed as if the program were a shell.
  1672. TEXT: H     However, using this option increases the start-up time of
  1673. TEXT: H     the program a lot.  Probably Gspice Hshould not be used as a
  1674. TEXT: H     login shell.
  1675. TEXT: H
  1676. TEXT: 
  1677. SEEALSO: NUTMEG:unixcom
  1678. SEEALSO: NUTMEG:commands
  1679.  
  1680. SUBJECT: variablesub
  1681. TITLE: Variable Substitution
  1682. TEXT: 
  1683. TEXT:      The values of variables may be used in commands by writing
  1684. TEXT: H     G$varname Hwhere the value of the variable is to appear.  The
  1685. TEXT: H     special variables $$ and $< refer to the process ID of the
  1686. TEXT: H     program and a line of input which is read from the terminal
  1687. TEXT: H     when the variable is evaluated, respectively.  If a variable
  1688. TEXT: H     has a name of the form $&_w_o_r_d, then _w_o_r_d is considered a
  1689. TEXT: H     vector, and its value is taken to be the value of the vari-
  1690. TEXT: H     able.  If $_f_o_o is a valid variable, and is of type GlistH,
  1691. TEXT: H     then the expression $_f_o_o[_l_o_w-_h_i_g_h] represents a range of
  1692. TEXT: H     elements.  Either the upper index or the lower may be left
  1693. TEXT: H     out, and the reverse of a list may be obtained with
  1694. TEXT: H     $_f_o_o[_l_e_n-_0].  Also, the notation $?_f_o_o evaluates to 1 if the
  1695. TEXT: H     variable _f_o_o is defined, 0 otherwise, and $#_f_o_o evaluates to
  1696. TEXT: H     the number of elements in _f_o_o if it is a list, 1 if it is a
  1697. TEXT: H     number or string, and 0 if it is a boolean variable.
  1698. TEXT: H
  1699. TEXT: 
  1700.  
  1701. SUBJECT: expressions
  1702. TITLE: Expressions
  1703. TEXT: 
  1704. TEXT:      An expression is an algebraic combination of already defined
  1705. TEXT: H     vectors, constants, operations, and functions.  The func-
  1706. TEXT: H     tions may be pre-defined functions or user-defined macros.
  1707. TEXT: H
  1708. TEXT:      A vector must either be defined in the Gcurrent plot Hor be
  1709. TEXT: H     defined in the Gconstant plotH, a set of constants which are
  1710. TEXT: H     described below.  A Gplot His a group of vectors that come
  1711. TEXT: H     from the same simulation or otherwise belong together.  The
  1712. TEXT: H     current plot can be changed by the Gsetplot Hcommand, and is
  1713. TEXT: H     generally the results of the last simulation run or the con-
  1714. TEXT: H     tents of the last Grawfile Hloaded in.  If no other plots are
  1715. TEXT: H     defined, the current plot is the constant plot.
  1716. TEXT: H
  1717. TEXT:      The case of alphabetic characters in a vector name is not
  1718. TEXT: H     significant.
  1719. TEXT: H
  1720. TEXT:      To reference vectors in a plot that is not the _c_u_r_r_e_n_t _p_l_o_t
  1721. TEXT: H     (see the Gsetplot Hcommand, below), the notation
  1722. TEXT: H     Gplotname.vecname Hcan be used.  Either a plotname or a vector
  1723. TEXT: H     name may be the wildcard GallH.  If the plotname is GallH,
  1724. TEXT: H     matching vectors from all plots are specified, and if the
  1725. TEXT: H     vector name is GallH, all vectors in the specified plots are
  1726. TEXT: H     referenced.  (The Gconstant plot His never matched by a plot
  1727. TEXT: H     wildcard, however.) Note that you may not use binary opera-
  1728. TEXT: H     tions on expressions involving wildcards - it is not obvious
  1729. TEXT: H     what Gall + all Hshould denote, for instance.
  1730. TEXT: H
  1731. TEXT:      In GspiceH, a vector name beginning with the `@' symbol is
  1732. TEXT: H     considered a reference to an internal device or model param-
  1733. TEXT: H     eter, or a circuit parameter.  If the vector name is of the
  1734. TEXT: H     form G@H_n_a_m_eG[H_p_a_r_a_mG]H, this denotes the parameter _p_a_r_a_m of the
  1735. TEXT: H     device or model named _n_a_m_e.  Of course, there must be a dev-
  1736. TEXT: H     ice or model with that name defined for the current circuit
  1737. TEXT: H     and _p_a_r_a_m must be a valid parameter name for that device or
  1738. TEXT: H     model type.  See the SPICE3 User's Guide for a listing of
  1739. TEXT: H     the parameters available.  If the vector name is of the form
  1740. TEXT: H     G@H_p_a_r_a_m, this refers to a parameter of the circuit with the
  1741. TEXT: H     name _p_a_r_a_m.  Currently, the only parameters available are
  1742. TEXT: H     the resource variables described under the Grusage Hcommand.
  1743. TEXT: H     These vectors may be used as arguments to Gtrace, save, Hand
  1744. TEXT: H     Giplot Hin addition to GprintH.
  1745. TEXT: H
  1746. TEXT:      A detailed description of the format a number may be written
  1747. TEXT: H     in can be found in the SPICE3 User's Guide - examples are
  1748. TEXT: H     G14.6MEG Hand G-1.231E-4H. Note that you can either use scien-
  1749. TEXT: H     tific notation or one of the abbreviations like _M_E_G or _G,
  1750. TEXT: H     but not both.  A number may have trailing alphabetic charac-
  1751. TEXT: H     ters after it.
  1752. TEXT: H
  1753. TEXT:      Vector names may be of the form _s_t_r_i_n_g(_s_o_m_e_t_h_i_n_g), if the
  1754. TEXT: H     _s_t_r_i_n_g is not the name of a built-in or user-defined func-
  1755. TEXT: H     tion.
  1756. TEXT: H
  1757. TEXT:      Some examples of expressions are:
  1758. TEXT: H
  1759. TEXT:           GcosH(TIME) + GdbH(v(3))
  1760. TEXT: H
  1761. TEXT:           GsinH(GcosH(GlogH(10)))
  1762. TEXT: H
  1763. TEXT:           TIME * GrndH(v(9)) - 15 * GcosH(vin#branch) ^ 7.9e5
  1764. TEXT: H
  1765. TEXT:           Gnot H((ac3.FREQ[32] G& Htran1.TIME[10]) Ggt H3)
  1766. TEXT: H
  1767. TEXT: 
  1768. SUBTOPIC: NUTMEG:constants NUTMEG:functions NUTMEG:operators
  1769.  
  1770. SEEALSO: NUTMEG:plot
  1771. SEEALSO: NUTMEG:print
  1772.  
  1773. SUBJECT: constants
  1774. TITLE: Constants
  1775. TEXT: 
  1776. TEXT:      The following values are defined in a plot called the Gcon-
  1777. TEXT: H     stant Hplot.  This is the default plot if no rawfile has been
  1778. TEXT: H     loaded and no simulation has been run.  Note that these con-
  1779. TEXT: H     stants are visible no matter what the current plot is, but
  1780. TEXT: H     they are overridden by a vector with the same name in the
  1781. TEXT: H     current plot.  These values are in MKS units.
  1782. TEXT: H
  1783. TEXT: 
  1784. SUBTOPIC: NUTMEG:boltz NUTMEG:c NUTMEG:e
  1785. SUBTOPIC: NUTMEG:echarge NUTMEG:false NUTMEG:i
  1786. SUBTOPIC: NUTMEG:kelvin NUTMEG:no NUTMEG:pi
  1787. SUBTOPIC: NUTMEG:planck NUTMEG:true NUTMEG:yes
  1788.  
  1789.  
  1790. SUBJECT: boltz
  1791. TITLE: boltz
  1792. TEXT: 
  1793. TEXT:      Gboltz
  1794. TEXT: H          HBoltzman's constant (1.38062e-23 joules/degree kelvin).
  1795. TEXT: H
  1796. TEXT: 
  1797.  
  1798. SUBJECT: c
  1799. TITLE: c
  1800. TEXT: 
  1801. TEXT:      Gc    HThe speed of light (2.997925e8 meters/second).
  1802. TEXT: H
  1803. TEXT: 
  1804.  
  1805. SUBJECT: e
  1806. TITLE: e
  1807. TEXT: 
  1808. TEXT:      Ge    HThe base of natural logarithms
  1809. TEXT: H          (2.71828182844590452353).
  1810. TEXT: H
  1811. TEXT: 
  1812.  
  1813. SUBJECT: echarge
  1814. TITLE: echarge
  1815. TEXT: 
  1816. TEXT:      Gecharge
  1817. TEXT: H          HThe charge on an electron (1.60219e-19 coulombs).
  1818. TEXT: H
  1819. TEXT: 
  1820.  
  1821. SUBJECT: false
  1822. TITLE: false
  1823. TEXT: 
  1824. TEXT:      Gfalse
  1825. TEXT: H          HDefined as 0.
  1826. TEXT: H
  1827. TEXT: 
  1828.  
  1829. SUBJECT: i
  1830. TITLE: i
  1831. TEXT: 
  1832. TEXT:      Gi    HThe square root of -1.  In our expression syntax, this
  1833. TEXT: H          may also be written as G(0,1)H.
  1834. TEXT: H
  1835. TEXT: 
  1836.  
  1837. SUBJECT: kelvin
  1838. TITLE: kelvin
  1839. TEXT: 
  1840. TEXT:      Gkelvin
  1841. TEXT: H          HAbsolute zero in centagrade (-273.15 degrees).
  1842. TEXT: H
  1843. TEXT: 
  1844.  
  1845. SUBJECT: no
  1846. TITLE: no
  1847. TEXT: 
  1848. TEXT:      Gno   HDefined as 0.
  1849. TEXT: H
  1850. TEXT: 
  1851.  
  1852. SUBJECT: pi
  1853. TITLE: pi
  1854. TEXT: 
  1855. TEXT:      Gpi   HPi (3.14159265358979323846).
  1856. TEXT: H
  1857. TEXT: 
  1858.  
  1859. SUBJECT: planck
  1860. TITLE: planck
  1861. TEXT: 
  1862. TEXT:      Gplanck
  1863. TEXT: H          HPlanck's constant (6.62620e-34 joule-seconds).
  1864. TEXT: H
  1865. TEXT: 
  1866.  
  1867. SUBJECT: true
  1868. TITLE: true
  1869. TEXT: 
  1870. TEXT:      Gtrue HDefined as 1.
  1871. TEXT: H
  1872. TEXT: 
  1873.  
  1874. SUBJECT: yes
  1875. TITLE: yes
  1876. TEXT: 
  1877. TEXT:      Gyes  HDefined as 1.
  1878. TEXT: H
  1879. TEXT: 
  1880.  
  1881. SUBJECT: functions
  1882. TITLE: Functions
  1883. TEXT: 
  1884. TEXT:      The pre-defined functions available are listed below.  In
  1885. TEXT: H     general, all operations and functions will work on either
  1886. TEXT: H     real or complex values.  Operations such as the logarithm of
  1887. TEXT: H     a negative number will yield errors, however.
  1888. TEXT: H
  1889. TEXT:      Note that all functions and operations operate pointwise on
  1890. TEXT: H     their arguments unless otherwise described.
  1891. TEXT: H
  1892. TEXT: 
  1893. SUBTOPIC: NUTMEG:abs NUTMEG:atan NUTMEG:cos
  1894. SUBTOPIC: NUTMEG:db NUTMEG:exp NUTMEG:im
  1895. SUBTOPIC: NUTMEG:interpolate NUTMEG:j NUTMEG:length
  1896. SUBTOPIC: NUTMEG:ln NUTMEG:log NUTMEG:mag
  1897. SUBTOPIC: NUTMEG:mean NUTMEG:norm NUTMEG:ph
  1898. SUBTOPIC: NUTMEG:pos NUTMEG:re NUTMEG:rnd
  1899. SUBTOPIC: NUTMEG:sin NUTMEG:sqrt NUTMEG:tan
  1900. SUBTOPIC: NUTMEG:unitvec NUTMEG:vector
  1901.  
  1902. SUBJECT: abs
  1903. TITLE: abs
  1904. TEXT: 
  1905. TEXT:      Gabs  HAbsolute value.  This is actually the same function as
  1906. TEXT: H          GmagH.
  1907. TEXT: H
  1908. TEXT: 
  1909.  
  1910. SUBJECT: atan
  1911. TITLE: atan
  1912. TEXT: 
  1913. TEXT:      Gatan HArc tangent.  This function (and all the trig func-
  1914. TEXT: H          tions) treat their arguments as radians unless the
  1915. TEXT: H          Gunits Hvariable is set to GdegreesH.
  1916. TEXT: H
  1917. TEXT: 
  1918.  
  1919. SUBJECT: cos
  1920. TITLE: cos
  1921. TEXT: 
  1922. TEXT:      Gcos  HThe cosine of the argument.
  1923. TEXT: H
  1924. TEXT: 
  1925.  
  1926. SUBJECT: db
  1927. TITLE: db
  1928. TEXT: 
  1929. TEXT:      Gdb   HDecibels (20.0 * log base 10 of the argument).
  1930. TEXT: H
  1931. TEXT: 
  1932.  
  1933. SUBJECT: exp
  1934. TITLE: exp
  1935. TEXT: 
  1936. TEXT:      Gexp  HE to the power of the argument.
  1937. TEXT: H
  1938. TEXT: 
  1939.  
  1940. SUBJECT: im
  1941. TITLE: im
  1942. TEXT: 
  1943. TEXT:      Gim   HThe imaginary part of the argument.
  1944. TEXT: H
  1945. TEXT: 
  1946.  
  1947. SUBJECT: interpolate
  1948. TITLE: interpolate
  1949. TEXT: 
  1950. TEXT:      Ginterpolate
  1951. TEXT: H          HThis function takes its data and interpolates it onto a
  1952. TEXT: H          grid which is determined by the scale of the currently
  1953. TEXT: H          active plot.  The degree is determined by the Gpolyde-
  1954. TEXT: H          gree Hvariable.  This is especially useful if the argu-
  1955. TEXT: H          ment belongs to a plot which is not the current one.
  1956. TEXT: H          Some restrictions are that the current scale, the old
  1957. TEXT: H          scale, and the argument must be real, and that either
  1958. TEXT: H          both scales must be strictly increasing or strictly
  1959. TEXT: H          decreasing.
  1960. TEXT: H
  1961. TEXT: 
  1962.  
  1963. SUBJECT: j
  1964. TITLE: j
  1965. TEXT: 
  1966. TEXT:      Gj    HThe argument multiplied by the square root of -1.
  1967. TEXT: H
  1968. TEXT: 
  1969.  
  1970. SUBJECT: length
  1971. TITLE: length
  1972. TEXT: 
  1973. TEXT:      Glength
  1974. TEXT: H          HThe length of the argument.
  1975. TEXT: H
  1976. TEXT: 
  1977.  
  1978. SUBJECT: ln
  1979. TITLE: ln
  1980. TEXT: 
  1981. TEXT:      Gln   HThe natural logarithm of the argument.
  1982. TEXT: H
  1983. TEXT: 
  1984.  
  1985. SUBJECT: log
  1986. TITLE: log
  1987. TEXT: 
  1988. TEXT:      Glog  HThe logarithm base 10 of the argument.
  1989. TEXT: H
  1990. TEXT: 
  1991.  
  1992. SUBJECT: mag
  1993. TITLE: mag
  1994. TEXT: 
  1995. TEXT:      Gmag  HThe magnitude of the argument.
  1996. TEXT: H
  1997. TEXT: 
  1998.  
  1999. SUBJECT: mean
  2000. TITLE: mean
  2001. TEXT: 
  2002. TEXT:      Gmean HThe mean value of the elements in the argument.  This
  2003. TEXT: H          returns a vector of length 1.
  2004. TEXT: H
  2005. TEXT: 
  2006.  
  2007. SUBJECT: norm
  2008. TITLE: norm
  2009. TEXT: 
  2010. TEXT:      Gnorm HThe elements of the argument are all multiplied by the
  2011. TEXT: H          magnitude of the inverse of the largest argument.
  2012. TEXT: H
  2013. TEXT: 
  2014.  
  2015. SUBJECT: ph
  2016. TITLE: ph
  2017. TEXT: 
  2018. TEXT:      Gph   HThe phase of the argument (expressed in radians).
  2019. TEXT: H
  2020. TEXT: 
  2021.  
  2022. SUBJECT: pos
  2023. TITLE: pos
  2024. TEXT: 
  2025. TEXT:      Gpos  HThis function returns a vector which is 1 if the
  2026. TEXT: H          corresponding element of the argument has a non-0 real
  2027. TEXT: H          part, and 0 otherwise.
  2028. TEXT: H
  2029. TEXT: 
  2030.  
  2031. SUBJECT: re
  2032. TITLE: re
  2033. TEXT: 
  2034. TEXT:      Gre   HThe real part of the argument.
  2035. TEXT: H
  2036. TEXT: 
  2037.  
  2038. SUBJECT: rnd
  2039. TITLE: rnd
  2040. TEXT: 
  2041. TEXT:      Grnd  HThis function returns a vector which contains random
  2042. TEXT: H          values between 0 and the corresponding element of the
  2043. TEXT: H          argument.  If the argument is complex then the random
  2044. TEXT: H          value is also complex.
  2045. TEXT: H
  2046. TEXT: 
  2047.  
  2048. SUBJECT: sin
  2049. TITLE: sin
  2050. TEXT: 
  2051. TEXT:      Gsin  HThe sine of the argument.
  2052. TEXT: H
  2053. TEXT: 
  2054.  
  2055. SUBJECT: sqrt
  2056. TITLE: sqrt
  2057. TEXT: 
  2058. TEXT:      Gsqrt HThe square root of the argument.
  2059. TEXT: H
  2060. TEXT: 
  2061.  
  2062. SUBJECT: tan
  2063. TITLE: tan
  2064. TEXT: 
  2065. TEXT:      Gtan  HThe tangent of the argument.
  2066. TEXT: H
  2067. TEXT: 
  2068.  
  2069. SUBJECT: unitvec
  2070. TITLE: unitvec
  2071. TEXT: 
  2072. TEXT:      Gunitvec
  2073. TEXT: H          HThis function returns a vector consisting of all 1's,
  2074. TEXT: H          with length equal to the magnitute of its argument.
  2075. TEXT: H
  2076. TEXT: 
  2077.  
  2078. SUBJECT: vector
  2079. TITLE: vector
  2080. TEXT: 
  2081. TEXT:      Gvector
  2082. TEXT: H          HThis function returns a vector consisting of the
  2083. TEXT: H          integers from 0 up to the magnitude of its argument.
  2084. TEXT: H          This function and the Gunitvec Hfunction both examine
  2085. TEXT: H          only the first element of their arguments.
  2086. TEXT: H
  2087. TEXT: 
  2088.  
  2089. SUBJECT: operators
  2090. TITLE: Operators
  2091. TEXT: 
  2092. TEXT:      The operations available are described below.  They all take
  2093. TEXT: H     two operands, except for unary minus and unary negation (G~H).
  2094. TEXT: H
  2095. TEXT: 
  2096. SUBTOPIC: NUTMEG:and NUTMEG:comma NUTMEG:divide
  2097. SUBTOPIC: NUTMEG:eq NUTMEG:ge NUTMEG:gt
  2098. SUBTOPIC: NUTMEG:ind NUTMEG:le NUTMEG:lt
  2099. SUBTOPIC: NUTMEG:minus NUTMEG:mod NUTMEG:ne
  2100. SUBTOPIC: NUTMEG:not NUTMEG:or NUTMEG:plus
  2101. SUBTOPIC: NUTMEG:power NUTMEG:ran NUTMEG:times
  2102.  
  2103.  
  2104. SUBJECT: and
  2105. TITLE: and
  2106. TEXT: 
  2107. TEXT:      Gand Hor G&
  2108. TEXT: H          H1 if both operands are non-zero, 0 otherwise.
  2109. TEXT: H
  2110. TEXT: 
  2111.  
  2112. SUBJECT: comma
  2113. TITLE: comma
  2114. TEXT: 
  2115. TEXT:      G, H(comma)
  2116. TEXT: H          The notation _a G, H_b refers to the complex number with
  2117. TEXT: H          real part _a and imaginary part _b.  Such a construction
  2118. TEXT: H          may not be used in the argument list to a macro func-
  2119. TEXT: H          tion, however, since commas are used to seperate the
  2120. TEXT: H          arguments and parentheses may be ignored.  The expres-
  2121. TEXT: H          sion _a G+ j(H_bG) His equivalent.
  2122. TEXT: H
  2123. TEXT: 
  2124.  
  2125. SUBJECT: divide
  2126. TITLE: divide
  2127. TEXT: 
  2128. TEXT:      G/    HThe first operand divided by the second.
  2129. TEXT: H
  2130. TEXT: 
  2131.  
  2132. SUBJECT: eq
  2133. TITLE: eq
  2134. TEXT: 
  2135. TEXT:      Geq Hor G=
  2136. TEXT: H          H1 if both operands are equal, 0 otherwise.
  2137. TEXT: H
  2138. TEXT: 
  2139.  
  2140. SUBJECT: ge
  2141. TITLE: ge
  2142. TEXT: 
  2143. TEXT:      Gge Hor G>=
  2144. TEXT: H          H1 if the first operand is greater than or equal to the
  2145. TEXT: H          second, 0 otherwise.
  2146. TEXT: H
  2147. TEXT: 
  2148.  
  2149. SUBJECT: gt
  2150. TITLE: gt
  2151. TEXT: 
  2152. TEXT:      Ggt Hor G>
  2153. TEXT: H          H1 if the first operand is greater than the second, 0
  2154. TEXT: H          otherwise.
  2155. TEXT: H
  2156. TEXT: 
  2157.  
  2158. SUBJECT: ind
  2159. TITLE: ind
  2160. TEXT: 
  2161. TEXT:      _v_a_l_u_eG[H_i_n_d_e_xG] Hor _v_a_l_u_eG[H_l_o_w, _h_i_g_hG]
  2162. TEXT: H          HThe first notation refers to the _i_n_d_e_x'th element of
  2163. TEXT: H          _v_a_l_u_e.  The second notation refers to all of the ele-
  2164. TEXT: H          ments of _v_a_l_u_e which fall between the _h_i_g_h'th and the
  2165. TEXT: H          _l_o_w'th element, inclusive.  If _h_i_g_h is less than _l_o_w,
  2166. TEXT: H          the order of the elements in the result is reversed.
  2167. TEXT: H          Note that a complex _i_n_d_e_x will have the same effect as
  2168. TEXT: H          using the real part for the lower value and the ima-
  2169. TEXT: H          ginary part for the upper, since this is the way the
  2170. TEXT: H          parser reads this expression.
  2171. TEXT: H
  2172. TEXT: 
  2173.  
  2174. SUBJECT: le
  2175. TITLE: le
  2176. TEXT: 
  2177. TEXT:      Gle Hor G<=
  2178. TEXT: H          H1 if the first argument is less than or equal to the
  2179. TEXT: H          second, 0 otherwise.
  2180. TEXT: H
  2181. TEXT: 
  2182.  
  2183. SUBJECT: lt
  2184. TITLE: lt
  2185. TEXT: 
  2186. TEXT:      Glt Hor G<
  2187. TEXT: H          H1 if the first argument is less than the second, 0 oth-
  2188. TEXT: H          erwise.
  2189. TEXT: H
  2190. TEXT: 
  2191.  
  2192. SUBJECT: minus
  2193. TITLE: minus
  2194. TEXT: 
  2195. TEXT:      G-    HThe first argument minus the second.  Also may be used
  2196. TEXT: H          as unary minus.
  2197. TEXT: H
  2198. TEXT: 
  2199.  
  2200. SUBJECT: mod
  2201. TITLE: mod
  2202. TEXT: 
  2203. TEXT:      G%    HThe modulo operation.  The result is the remainder when
  2204. TEXT: H          the first number is divided by the second.  Note that
  2205. TEXT: H          both arguments are rounded down to the nearest integer
  2206. TEXT: H          before the operation is performed.
  2207. TEXT: H
  2208. TEXT: 
  2209.  
  2210. SUBJECT: ne
  2211. TITLE: ne
  2212. TEXT: 
  2213. TEXT:      Gne Hor G<>
  2214. TEXT: H          H1 if the two operands are not equal, 0 otherwise.
  2215. TEXT: H
  2216. TEXT: 
  2217.  
  2218. SUBJECT: not
  2219. TITLE: not
  2220. TEXT: 
  2221. TEXT:      Gnot Hor G~
  2222. TEXT: H          H1 if the operand is 0, 0 otherwise.
  2223. TEXT: H
  2224. TEXT: 
  2225.  
  2226. SUBJECT: or
  2227. TITLE: or
  2228. TEXT: 
  2229. TEXT:      Gor Hor G|
  2230. TEXT: H          H1 if either of the two operands is 1, 0 otherwise.
  2231. TEXT: H
  2232. TEXT: 
  2233.  
  2234. SUBJECT: plus
  2235. TITLE: plus
  2236. TEXT: 
  2237. TEXT:      G+    HThe plus operation.
  2238. TEXT: H
  2239. TEXT: 
  2240.  
  2241. SUBJECT: power
  2242. TITLE: power
  2243. TEXT: 
  2244. TEXT:      G^    HThe first operand raised to the power of the second.
  2245. TEXT: H          Note that if the base is less than 0, the exponent must
  2246. TEXT: H          be an integer.
  2247. TEXT: H
  2248. TEXT: 
  2249.  
  2250. SUBJECT: ran
  2251. TITLE: ran
  2252. TEXT: 
  2253. TEXT:      _v_a_l_u_e_1G[[H_v_a_l_u_e_2G]] Hor _v_a_l_u_eG[[H_l_o_w, _h_i_g_hG]]
  2254. TEXT: H          HThe first notation refers to all the elements of _v_a_l_u_e_1
  2255. TEXT: H          for which the element of the corresponding scale equals
  2256. TEXT: H          _v_a_l_u_e_2.  The second notation refers to all of the ele-
  2257. TEXT: H          ments of _v_a_l_u_e for which the corresponding elements of
  2258. TEXT: H          the scale fall between _h_i_g_h and _l_o_w, inclusive.  If
  2259. TEXT: H          _h_i_g_h is less than _l_o_w, the order of the elements in the
  2260. TEXT: H          result is reversed.
  2261. TEXT: H
  2262. TEXT: 
  2263.  
  2264. SUBJECT: times
  2265. TITLE: times
  2266. TEXT: 
  2267. TEXT:      G*    HThe multiplication operation.
  2268. TEXT: H
  2269. TEXT: 
  2270.  
  2271. SUBJECT: graphics
  2272. TITLE: Graphics
  2273. TEXT: 
  2274. TEXT:      GNutmeg Hcan make use of a number of graphics systems to
  2275. TEXT: H     display data for the Gplot Hand Ghardcopy Hcommands.  Currently
  2276. TEXT: H     the X graphics system is the best supported and prefered
  2277. TEXT: H     interface, and MFB (Model Frame Buffer) is used for graphics
  2278. TEXT: H     terminals.  The file format used by the Ghardcopy Hcommand is
  2279. TEXT: H     the UNIX _p_l_o_t(_5) format.
  2280. TEXT: H
  2281. TEXT:      If the UNIX environment variable GDISPLAY His defined, it is
  2282. TEXT: H     assumed that an X workstation is available.  Also, if the
  2283. TEXT: H     variable Gdisplay His set the value will be used as the name
  2284. TEXT: H     of the display to try to open.  If neither of these is set,
  2285. TEXT: H     or if the program was not compiled with X, MFB is used for
  2286. TEXT: H     graphics.
  2287. TEXT: H
  2288. TEXT: 
  2289. SUBTOPIC: NUTMEG:X
  2290. SEEALSO: NUTMEG:plot
  2291.  
  2292. SUBJECT: X
  2293. TITLE: X
  2294. TEXT: 
  2295. TEXT:      When a plot is requested and X is available, a plot window
  2296. TEXT: H     is opened.  If the variable Gmaxwins His set and there are
  2297. TEXT: H     already that many plot windows available, the oldest one is
  2298. TEXT: H     re-used.  If the window being opened is the _nth window, and
  2299. TEXT: H     the variable GgeometryH_n is defined, then this string is used
  2300. TEXT: H     as the window's geometry (see the X documentation for a
  2301. TEXT: H     description of geometry specifications).  Otherwise the user
  2302. TEXT: H     is prompted for the window's size and position: as usual,
  2303. TEXT: H     the left button will create the window with the default size
  2304. TEXT: H     and position, the middle button allows the user to drag the
  2305. TEXT: H     window open, and the right button allows the user to create
  2306. TEXT: H     a window of the default size at any location.  The defaults
  2307. TEXT: H     are such that the window will be 1/3 the height and width of
  2308. TEXT: H     the screen, positioned in the center.
  2309. TEXT: H
  2310. TEXT:      After the window is created and the data is plotted, the
  2311. TEXT: H     buttons have various functions.  The left button causes a
  2312. TEXT: H     new plot command to be issued, with the limits on the x- and
  2313. TEXT: H     y-axis roughly 4 times the size of those in the first window
  2314. TEXT: H     (i.e, zoom out).  The middle button causes the window to
  2315. TEXT: H     disappear.  The right button allows the user to drag open a
  2316. TEXT: H     box (or circle), and then creates a new window which zooms
  2317. TEXT: H     in on this area.
  2318. TEXT: H
  2319. TEXT:      If the cursor is positioned in a plot window and characters
  2320. TEXT: H     are typed on the keyboard, they will appear as text in the
  2321. TEXT: H     window in the same font as the other text.  The cursor will
  2322. TEXT: H     move to the right as text is added, but due to the way X
  2323. TEXT: H     windows are handled by GnutmegH, text must be typed slowly so
  2324. TEXT: H     the cursor can keep up with it.  This allows one to add text
  2325. TEXT: H     to a window or remove it with spaces before sending it to a
  2326. TEXT: H     printer with a window-dump program.
  2327. TEXT: H
  2328. TEXT:      If a Ghardcopy Hcommand with no expressions is given, the user
  2329. TEXT: H     will be prompted to select a window which will be dumped
  2330. TEXT: H     into the file.
  2331. TEXT: H
  2332. TEXT:      If a Ghelp Hwindow is also on the screen, all updates
  2333. TEXT: H     (refreshes, etc) in plot windows will be delayed until the
  2334. TEXT: H     help window is exited.
  2335. TEXT: H
  2336. TEXT: 
  2337. SEEALSO: NUTMEG:help
  2338.  
  2339. SUBJECT: hpux
  2340. TITLE: HP-UX Notes
  2341. TEXT: 
  2342. TEXT:      GNutmeg Hruns on the HP series 9000 computers.
  2343. TEXT: H
  2344. TEXT: 
  2345.  
  2346. SUBJECT: input
  2347. TITLE: Circuit Input Format
  2348. TEXT: 
  2349. TEXT:                The input format for SPICE is of the free format  type.
  2350. TEXT: H          Fields  on  a  line  are  separated by one or more blanks, a
  2351. TEXT: H          comma, an equal (=) sign, or a left  or  right  parenthesis;
  2352. TEXT: H          extra spaces are ignored.  A line may be continued by enter-
  2353. TEXT: H          ing a + (plus) in column 1 of the following line; SPICE con-
  2354. TEXT: H          tinues reading beginning with column 2.
  2355. TEXT: H
  2356. TEXT:                A name field must begin with a letter (A through Z) and
  2357. TEXT: H          cannot contain any delimiters.  SPICE is not case-sensitive.
  2358. TEXT: H
  2359. TEXT:                A number field may be an integer  field  (12,  -44),  a
  2360. TEXT: H          floating  point field (3.14159), either an integer or float-
  2361. TEXT: H          ing point number followed by  an  integer  exponent  (1E-14,
  2362. TEXT: H          2.65E3),  or  either  an  integer or a floating point number
  2363. TEXT: H          followed by one of the following scale factors:
  2364. TEXT: H
  2365. TEXT:           T = 1E12   G = 1E9    MEG = 1E6   K = 1E3     MIL = 25.4E-6
  2366. TEXT: H          M = 1E-3   U = 1E-6   N = 1E-9    P = 1E-12   F = 1E-15
  2367. TEXT: H
  2368. TEXT: 
  2369. TEXT:                Letters immediately following a  number  that  are  not
  2370. TEXT: H          scale factors are ignored, and letters immediately following
  2371. TEXT: H          a scale factor are ignored.  Hence, 10,  10V,  10VOLTS,  and
  2372. TEXT: H          10HZ  all  represent  the  same number, and M, MA, MSEC, and
  2373. TEXT: H          MMHOS all represent  the  same  scale  factor.   Thus  1000,
  2374. TEXT: H          1000.0,  1000HZ,  1E3, 1.0E3, 1KHZ, and 1K all represent the
  2375. TEXT: H          same number.
  2376. TEXT: H
  2377. TEXT:                The circuit to be analyzed is described to SPICE  by  a
  2378. TEXT: H          set  of _e_l_e_m_e_n_t _l_i_n_e_s, which define the circuit topology and
  2379. TEXT: H          element values, and a set of control lines, which define the
  2380. TEXT: H          model  parameters  and  the run controls.  The first line in
  2381. TEXT: H          the input file must be a title line, and the last line  must
  2382. TEXT: H          be  a  G.END Hline.  The order of the remaining lines is arbi-
  2383. TEXT: H          trary (except,  of  course,  that  continuation  lines  must
  2384. TEXT: H          immediately  follow  the  line  being continued, and element
  2385. TEXT: H          lines belonging to a subcircuit must be between the  G.SUBCKT
  2386. TEXT: H          Hand G.ENDS Hlines for that subcircuit).
  2387. TEXT: H
  2388. TEXT:                Each element in the circuit is specified by an  element
  2389. TEXT: H          line  that  contains  the element name, the circuit nodes to
  2390. TEXT: H          which the element is connected, and the values of the param-
  2391. TEXT: H          eters  that  determine the electrical characteristics of the
  2392. TEXT: H          element.  The first letter of the element name specifies the
  2393. TEXT: H          element  type.   The  format  for the SPICE element types is
  2394. TEXT: H          given in what follows.  The strings  XXXXXXX,  YYYYYYY,  and
  2395. TEXT: H          ZZZZZZZ denote arbitrary alphanumeric strings.  For example,
  2396. TEXT: H          a resistor name must begin with the letter `R' and can  con-
  2397. TEXT: H          tain  one  or more characters.  Hence, R, R1, RSE, ROUT, and
  2398. TEXT: H          R3AC2ZY are valid resistor names.
  2399. TEXT: H
  2400. TEXT: 
  2401. TEXT:                Data fields that are enclosed in less than and  greater
  2402. TEXT: H          than  signs  '<  >' are optional.  All indicated punctuation
  2403. TEXT: H          (parentheses, equal signs,  etc.)  is  optional  and  merely
  2404. TEXT: H          indicate  the presence of any delimiter.  A consistent style
  2405. TEXT: H          such as that shown here will make the input easier to under-
  2406. TEXT: H          stand.   With respect to branch voltages and currents, SPICE
  2407. TEXT: H          uniformly uses the associated reference convention  (current
  2408. TEXT: H          flows in the direction of voltage drop).
  2409. TEXT: H
  2410. TEXT:                Nodes names may be arbitrary  character  strings.   The
  2411. TEXT: H          datum  (ground)  node must be named '0'.  The circuit cannot
  2412. TEXT: H          contain a loop of voltage sources and/or inductors and  can-
  2413. TEXT: H          not  contain  a cutset of current sources and/or capacitors.
  2414. TEXT: H          Each node in the circuit must have  a  dc  path  to  ground.
  2415. TEXT: H          Every  node  must  have  at least two connections except for
  2416. TEXT: H          transmission line nodes (to permit unterminated transmission
  2417. TEXT: H          lines)  and  MOSFET substrate nodes (which have two internal
  2418. TEXT: H          connections anyway).
  2419. TEXT: H
  2420. TEXT: 
  2421. SUBTOPIC: NUTMEG:comment NUTMEG:endcard NUTMEG:ic
  2422. SUBTOPIC: NUTMEG:include NUTMEG:nodeset NUTMEG:option
  2423. SUBTOPIC: NUTMEG:subckts NUTMEG:titlecard
  2424. SEEALSO: NUTMEG:source
  2425.  
  2426. SUBJECT: comment
  2427. TITLE: Comment Lines
  2428. TEXT: 
  2429. TEXT:                An asterisk in the first  column  indicates  that  this
  2430. TEXT: H          line  is  a  comment line.  Comment lines may be placed any-
  2431. TEXT: H          where in the circuit description.
  2432. TEXT: H
  2433. TEXT:           GGeneral Form:
  2434. TEXT: H
  2435. TEXT:               * H_a_r_b_i_t_r_a_r_y _t_e_x_t
  2436. TEXT: H
  2437. TEXT:           GExamples:
  2438. TEXT: H
  2439. TEXT:               * HRF=1K      GAIN SHOULD BE 100
  2440. TEXT: H              G* HMAY THE FORCE BE WITH MY CIRCUIT
  2441. TEXT: H
  2442. TEXT: 
  2443.  
  2444. SUBJECT: endcard
  2445. TITLE: End Line
  2446. TEXT: 
  2447. TEXT:                This line must always be the last  line  in  the  input
  2448. TEXT: H          file.  Note that the period is an integral part of the name.
  2449. TEXT: H
  2450. TEXT:           GExamples:
  2451. TEXT: H
  2452. TEXT:                H.GEND
  2453. TEXT: H
  2454. TEXT: 
  2455.  
  2456. SUBJECT: ic
  2457. TITLE: IC Line
  2458. TEXT: 
  2459. TEXT:           GGeneral form:
  2460. TEXT: H
  2461. TEXT:                .IC HV(_N_O_D_N_U_M)=_V_A_L V(_N_O_D_N_U_M)=_V_A_L ...
  2462. TEXT: H
  2463. TEXT:           GExamples:
  2464. TEXT: H
  2465. TEXT:                .IC HV(11)=5 V(4)=-5 V(2)=2.2
  2466. TEXT: H
  2467. TEXT: 
  2468. TEXT:                This line is for setting transient initial  conditions.
  2469. TEXT: H          It  has  two different interpretations, depending on whether
  2470. TEXT: H          the GUIC Hparameter is specified on the G.TRAN Hline.  Also, one
  2471. TEXT: H          should  not  confuse  this line with the G.NODESET Hline.  The
  2472. TEXT: H          G.NODESET Hline is only to help dc convergence, and  does  not
  2473. TEXT: H          affect  final  bias  solution  (except for multi-stable cir-
  2474. TEXT: H          cuits).  The two interpretations of this line  are  as  fol-
  2475. TEXT: H          lows:
  2476. TEXT: H
  2477. TEXT:           1.   When the GUIC Hparameter is specified on the G.TRAN  Hline,
  2478. TEXT: H               then  the  node  voltages specified on the G.IC Hline are
  2479. TEXT: H               used to compute the capacitor, diode,  BJT,  JFET,  and
  2480. TEXT: H               MOSFET  initial  conditions.   This  is  equivalent  to
  2481. TEXT: H               specifying the GICH=... parameter on  each  device  line,
  2482. TEXT: H               but  is much more convenient.  The GICH=... parameter can
  2483. TEXT: H               still be specified and will take  precedence  over  the
  2484. TEXT: H               G.IC Hvalues.  Since no dc bias (initial transient) solu-
  2485. TEXT: H               tion is computed before  the  transient  analysis,  one
  2486. TEXT: H               should  take  care to specify all dc source voltages on
  2487. TEXT: H               the G.IC Hline if they are to be used to  compute  device
  2488. TEXT: H               initial conditions.
  2489. TEXT: H
  2490. TEXT:           2.   When the GUIC Hparameter is not specified  on  the  G.TRAN
  2491. TEXT: H               Hline,  the dc bias (initial transient) solution will be
  2492. TEXT: H               computed before the transient analysis.  In this  case,
  2493. TEXT: H               the node voltages specified on the Gbias solution.  Dur-
  2494. TEXT: H               ing transient analysis, the constraint  on  these  node
  2495. TEXT: H               voltages is removed.
  2496. TEXT: H
  2497. TEXT: 
  2498.  
  2499. SUBJECT: include
  2500. TITLE: INCLUDE Line
  2501. TEXT: 
  2502. TEXT:           GGeneral form:
  2503. TEXT: H
  2504. TEXT:                .INCLUDE H_F_I_L_E_N_A_M_E
  2505. TEXT: H
  2506. TEXT:           GExamples:
  2507. TEXT: H
  2508. TEXT:                .INCLUDE HMODELS.DEF
  2509. TEXT: H
  2510. TEXT: 
  2511. TEXT:                This line causes the named file to be interpolated into
  2512. TEXT: H          the  circuit at the point it appears.  Included files may be
  2513. TEXT: H          nested arbitrarily.  Comments are inserted into the  circuit
  2514. TEXT: H          at the beginning and end of the included segments.
  2515. TEXT: H
  2516. TEXT: 
  2517.  
  2518. SUBJECT: nodeset
  2519. TITLE: Nodeset Line
  2520. TEXT: 
  2521. TEXT:           GGeneral form:
  2522. TEXT: H
  2523. TEXT:                .NODESET HV(_N_O_D_N_U_M)=_V_A_L V(_N_O_D_N_U_M)=_V_A_L ...
  2524. TEXT: H
  2525. TEXT:           GExamples:
  2526. TEXT: H
  2527. TEXT:                .NODESET HV(12)=4.5 V(4)=2.23
  2528. TEXT: H
  2529. TEXT: 
  2530. TEXT:                This line helps the program  find  the  dc  or  initial
  2531. TEXT: H          transient  solution  by  making  a preliminary pass with the
  2532. TEXT: H          specified nodes held to the given voltages.  The restriction
  2533. TEXT: H          is  then  released  and  the iteration continues to the true
  2534. TEXT: H          solution.  A G.NODESET Hline may be necessary for  convergence
  2535. TEXT: H          on  bistable  or  astable  circuits.   In general, this line
  2536. TEXT: H          should not be necessary.
  2537. TEXT: H
  2538. TEXT: 
  2539.  
  2540. SUBJECT: option
  2541. TITLE: Option Line
  2542. TEXT: 
  2543. TEXT:           GGeneral form:
  2544. TEXT: H
  2545. TEXT:                .OPTIONS H_O_P_T_1 _O_P_T_2 ... (or _O_P_T=_O_P_T_V_A_L ...)
  2546. TEXT: H
  2547. TEXT:           GExamples:
  2548. TEXT: H
  2549. TEXT:                .OPTIONS HRELTOL=.005 TRTOL=8
  2550. TEXT: H
  2551. TEXT: 
  2552. TEXT:                This line allows the user to reset program control  and
  2553. TEXT: H          user options for specific simulation purposes.
  2554. TEXT: H
  2555. TEXT: 
  2556. SEEALSO: NUTMEG:set
  2557.  
  2558. SUBJECT: pc
  2559. TITLE: MS-DOS Notes
  2560. TEXT: 
  2561. TEXT:      GNutmeg Hruns on the IBM PC.
  2562. TEXT: H
  2563. TEXT: 
  2564.  
  2565. SUBJECT: proglang
  2566. TITLE: The Command Language
  2567. TEXT: 
  2568. TEXT:      Gnutmeg Hcommands include constructs for looping, conditional
  2569. TEXT: H     execution, etc. Thus simple programs may be written and exe-
  2570. TEXT: H     cuted as scripts.  As a programming language it is quite
  2571. TEXT: H     simple, however, and line oriented (all blocks must begin
  2572. TEXT: H     with some sort of control statement, like _i_f, and end with
  2573. TEXT: H     the _e_n_d statement).  Because of GnutmegH's numeric orienta-
  2574. TEXT: H     tion, string variables are only minimally supported and are
  2575. TEXT: H     quite awkward to deal with.  (See the Gstrcmp Hcommand.)
  2576. TEXT: H
  2577. TEXT:      The following control structures are available:
  2578. TEXT: H
  2579. TEXT: 
  2580. TEXT: H          Gwhile H_c_o_n_d_i_t_i_o_n
  2581. TEXT: H               _s_t_a_t_e_m_e_n_t
  2582. TEXT: H               ...
  2583. TEXT: H          Gend
  2584. TEXT: H
  2585. TEXT:      HWhile _c_o_n_d_i_t_i_o_n, an arbitrary algebraic expression, is true,
  2586. TEXT: H     execute the _s_t_a_t_e_m_e_n_ts.
  2587. TEXT: H
  2588. TEXT: 
  2589. TEXT: H          Grepeat H[_n_u_m_b_e_r]
  2590. TEXT: H               _s_t_a_t_e_m_e_n_t
  2591. TEXT: H               ...
  2592. TEXT: H          Gend
  2593. TEXT: H
  2594. TEXT:      HExecute the _s_t_a_t_e_m_e_n_ts _n_u_m_b_e_r times, or forever if no argu-
  2595. TEXT: H     ment is given.
  2596. TEXT: H
  2597. TEXT: 
  2598. TEXT: H          Gdowhile H_c_o_n_d_i_t_i_o_n
  2599. TEXT: H               _s_t_a_t_e_m_e_n_t
  2600. TEXT: H               ...
  2601. TEXT: H          Gend
  2602. TEXT: H
  2603. TEXT:      HThe same as GwhileH, except that the _c_o_n_d_i_t_i_o_n is tested after
  2604. TEXT: H     the _s_t_a_t_e_m_e_n_ts are executed.
  2605. TEXT: H
  2606. TEXT: 
  2607. TEXT: H          Gforeach H_v_a_r _v_a_l_u_e ...
  2608. TEXT: H               _s_t_a_t_e_m_e_n_t
  2609. TEXT: H               ...
  2610. TEXT: H          Gend
  2611. TEXT: H
  2612. TEXT:      HThe _s_t_a_t_e_m_e_n_ts are executed once for each of the _v_a_l_u_es,
  2613. TEXT: H     each time with the variable _v_a_r set to the current one.
  2614. TEXT: H     (_v_a_r can be accessed by the $_v_a_r notation - see below).
  2615. TEXT: H
  2616. TEXT: 
  2617. TEXT: H          Gif H_c_o_n_d_i_t_i_o_n
  2618. TEXT: H               _s_t_a_t_e_m_e_n_t
  2619. TEXT: H               ...
  2620. TEXT: H          Gelse
  2621. TEXT: H               H_s_t_a_t_e_m_e_n_t
  2622. TEXT: H               ...
  2623. TEXT: H          Gend
  2624. TEXT: H
  2625. TEXT:      HIf the _c_o_n_d_i_t_i_o_n is non-zero then the first set of _s_t_a_t_e_-
  2626. TEXT: H     _m_e_n_ts are executed, otherwise the second set.  The Gelse Hand
  2627. TEXT: H     the second set of _s_t_a_t_e_m_e_n_ts may be omitted.
  2628. TEXT: H
  2629. TEXT:           Glabel H_w_o_r_d
  2630. TEXT: H
  2631. TEXT:      If a _s_t_a_t_e_m_e_n_t of the form Ggoto H_w_o_r_d is encountered, control
  2632. TEXT: H     is transfered to this point, otherwise this is a no-op.
  2633. TEXT: H
  2634. TEXT:           Ggoto H_w_o_r_d
  2635. TEXT: H
  2636. TEXT:      If a statement of the form Glabel H_w_o_r_d is present in the
  2637. TEXT: H     block or an enclosing block, control is transfered there.
  2638. TEXT: H     Note that if the label is at the top level, it _m_u_s_t be
  2639. TEXT: H     before the Ggoto Hstatement (i.e, a forward Ggoto Hmay occur
  2640. TEXT: H     only within a block).
  2641. TEXT: H
  2642. TEXT:           Gcontinue H[ _n_u_m_b_e_r ]
  2643. TEXT: H
  2644. TEXT:      If there is a Gwhile, dowhile, Hor Gforeach Hblock enclosing
  2645. TEXT: H     this statement, control passes to the test, or in the case
  2646. TEXT: H     of GforeachH, the next value is taken.  Otherwise an error
  2647. TEXT: H     results.  If a _n_u_m_b_e_r is given, that many surrounding blocks
  2648. TEXT: H     are continued.  If there are not that many blocks, an error
  2649. TEXT: H     results.
  2650. TEXT: H
  2651. TEXT:           Gbreak H[ _n_u_m_b_e_r ]
  2652. TEXT: H
  2653. TEXT:      If there is a Gwhile, dowhile, Hor Gforeach Hblock enclosing
  2654. TEXT: H     this statement, control passes out of the block. Otherwise
  2655. TEXT: H     an error results.  If a _n_u_m_b_e_r is given, that many surround-
  2656. TEXT: H     ing blocks are continued.  If there are not that many
  2657. TEXT: H     blocks, an error results.
  2658. TEXT: H
  2659. TEXT:      Control structures may be nested.  When a block is entered
  2660. TEXT: H     and the input is the terminal, the prompt becomes a number
  2661. TEXT: H     of >'s equalling the number of blocks the user has entered.
  2662. TEXT: H     The current control structures may be examined with the
  2663. TEXT: H     debugging command GcdumpH.
  2664. TEXT: H
  2665. TEXT:      There are predefined aliases Gendif, endwhileH, and so on for
  2666. TEXT: H     all the above control statements if you prefer them over
  2667. TEXT: H     GendH.
  2668. TEXT: H
  2669. TEXT:      If a word is typed as a command, and there is no built-in
  2670. TEXT: H     command with that name, the directories in the _s_o_u_r_c_e_p_a_t_h
  2671. TEXT: H     list are searched in order for the file.  If it is found, it
  2672. TEXT: H     is read in as a command file (as if it were GsourceH'd).
  2673. TEXT: H     Before it is read, however, the variables _a_r_g_c and _a_r_g_v are
  2674. TEXT: H     set to the number of words following the filename on the
  2675. TEXT: H     command line, and a list of those words respectively.  After
  2676. TEXT: H     the file is finished, these variables are GunsetH.  Note that
  2677. TEXT: H     if one command file calls another, it must save its _a_r_g_v and
  2678. TEXT: H     _a_r_g_c since they will be altered.  Also, command files should
  2679. TEXT: H     not be re-entrant since there are no local variables.  (Of
  2680. TEXT: H     course, the procedures may explicitly manipulate a global
  2681. TEXT: H     stack.) This way one can write scripts analogous to shell
  2682. TEXT: H     scripts for Gnutmeg Hand Gspice  HNote that for the script to
  2683. TEXT: H     work with GspiceH, it must begin with a blank line (or what-
  2684. TEXT: H     ever you like, since it will be thrown away) and then a line
  2685. TEXT: H     with G.control Hon it.  This is an unfortunate result of the
  2686. TEXT: H     Gsource Hcommand being used for both circuit input and command
  2687. TEXT: H     file execution.  Note also that this allows the user to
  2688. TEXT: H     merely type the name of a circuit file as a command, and it
  2689. TEXT: H     will be automatically loaded.
  2690. TEXT: H
  2691. TEXT:      For examples of Gnutmeg H"programs", check the scripts pro-
  2692. TEXT: H     vided in the _s_c_r_i_p_t_s directory in the SPICE3 library.  (This
  2693. TEXT: H     may be found in ~_c_a_d/_l_i_b/_s_p_i_c_e_3 on Berkeley machines.)
  2694. TEXT: H     Currently only the Gsetplot Hcommand is implemented as a
  2695. TEXT: H     script.
  2696. TEXT: H
  2697. TEXT: 
  2698. SEEALSO: NUTMEG:commands
  2699. SEEALSO: NUTMEG:unixcomcomm
  2700.  
  2701. SUBJECT: refs
  2702. TITLE: References
  2703. TEXT: 
  2704. TEXT:           [1] A. Vladimirescu and  S.  Liu,  "The  Simulation  of  MOS
  2705. TEXT: H          Integrated  Circuits  Using SPICE2", ERL Memo No. ERL M80/7,
  2706. TEXT: H          Electronics Research Laboratory, University  of  California,
  2707. TEXT: H          Berkeley, Oct. 1980.
  2708. TEXT: H
  2709. TEXT:           [2] B. J. Sheu, D. L. Scharfetter, and  P.  K.  Ko,  "SPICE2
  2710. TEXT: H          Implementation of BSIM" ERL Memo No. ERL M85/42, Electronics
  2711. TEXT: H          Research Laboratory, University of California, Berkeley, May
  2712. TEXT: H          1985.
  2713. TEXT: H
  2714. TEXT:           [3] J. R. Pierret, "A MOS Parameter Extraction  Program  for
  2715. TEXT: H          the  BSIM Model" ERL Memo Nos. ERL M84/99 and M84/100, Elec-
  2716. TEXT: H          tronics  Research  Laboratory,  University  of   California,
  2717. TEXT: H          Berkeley, Nov. 1984.
  2718. TEXT: H
  2719. TEXT:           [4] H.Statz et al.,"GaAs FET Device and  Circuit  Simulation
  2720. TEXT: H          in  SPICE", Internal memorandum, Raytheon Research Division,
  2721. TEXT: H          Lexington, Mass. ,1985.
  2722. TEXT: H
  2723. TEXT: 
  2724.  
  2725. SUBJECT: sconvert
  2726. TITLE: sconvert
  2727. TEXT: 
  2728. TEXT: GNAME
  2729. TEXT: H     Hsconvert - convert spice formats
  2730. TEXT: H
  2731. TEXT: GSYNOPSIS
  2732. TEXT: H     sconvert fromtype fromfile totype tofile
  2733. TEXT: H     sconvert fromtype totype
  2734. TEXT: H     sconvert
  2735. TEXT: H
  2736. TEXT: DESCRIPTION
  2737. TEXT: H     Sconvert Htranslates spice output files among three formats:
  2738. TEXT: H     the old binary format, a new binary format, and a new ascii
  2739. TEXT: H     format.  The formats are specified by the Gfromtype Hand
  2740. TEXT: H     Gtotype Harguments: `o' for the old format, `b' for the new
  2741. TEXT: H     binary format, and `a' for the new ascii format.  GFromtype
  2742. TEXT: H     Hspecifies the format to be read, and Gtotype Hspecifies the
  2743. TEXT: H     format to be written.  If Gfromfile Hand Gtofile Hare given,
  2744. TEXT: H     then they are used as the input and output, otherwise stan-
  2745. TEXT: H     dard input and output are used.  (Note that this second
  2746. TEXT: H     option is only available on UNIX systems - on VMS and other
  2747. TEXT: H     systems you must supply the filenames.) If no arguments are
  2748. TEXT: H     given, the parameters are prompted for.
  2749. TEXT: H
  2750. TEXT:      Binary format is the preferred format for general use, as it
  2751. TEXT: H     is the most economical in terms of space and speed of
  2752. TEXT: H     access, and ascii is provided to make it easy to modify data
  2753. TEXT: H     files and transfer them between machines with different
  2754. TEXT: H     floating-point formats.  The old format is provided only for
  2755. TEXT: H     backward compatibility.
  2756. TEXT: H
  2757. TEXT:      The ascii format consists of lines or sets of lines intro-
  2758. TEXT: H     duced by a keyword.  The GTitle Hand GDate Hlines should be the
  2759. TEXT: H     first in the file and should occus only once.  There may be
  2760. TEXT: H     any number of _p_l_o_t_s in the file, each one beginning with the
  2761. TEXT: H     GPlotnameH, GFlagsH, GNo. VariablesH, GNo. PointsH, GVariablesH, and
  2762. TEXT: H     GValues Hlines.  GCommand Hand GOption Hlines are optional and may
  2763. TEXT: H     occur anywhere between the GPlotname Hand GValues Hlines.  Note
  2764. TEXT: H     that after the GVariables Hkeyword there must be _n_u_m_v_a_r_s
  2765. TEXT: H     "declarations" of outputs, and after the GValues Hkeyword,
  2766. TEXT: H     there must be _n_u_m_p_o_i_n_t_s lines, each consisting of _n_u_m_v_a_r_s
  2767. TEXT: H     values.  (If this is confusing just create an ascii rawfile
  2768. TEXT: H     with Gnutmeg Hand look at it...)
  2769. TEXT: H      GLine name       Description
  2770. TEXT: H      HTitle           An arbitrary string describing the circuit
  2771. TEXT: H      Date            A free-format date string
  2772. TEXT: H      Plotname        A string describing the analysis type -
  2773. TEXT: H                      see the description for the Gdeftype
  2774. TEXT: H                      nutmeg Hcommand
  2775. TEXT: H      Flags           Currently, either Gcomplex Hor Greal
  2776. TEXT: H      HNo. Variables   The number of variables (_n_u_m_v_a_r_s)
  2777. TEXT: H      No. Points      The number of points (_n_u_m_p_o_i_n_t_s)
  2778. TEXT: H      Command         An arbitrary nutmeg command
  2779. TEXT: H      Option          Gnutmeg Hvariables
  2780. TEXT: H      Variables       A number of variable lines (see below)
  2781. TEXT: H      Values          A number of data lines (see below)
  2782. TEXT: H
  2783. TEXT:      Any text on a GCommand Hline is executed when the file is
  2784. TEXT: H     loaded as if it were typed as a command.  By default, Gspice
  2785. TEXT: H     Hputs a Gversion Hcommand into every rawfile it creates.
  2786. TEXT: H
  2787. TEXT:      Text on a GOption Hline is parsed as if it were the arguments
  2788. TEXT: H     to a Gnutmeg set Hcommand.  The variables set are then avail-
  2789. TEXT: H     able normally, except that they are read only and are asso-
  2790. TEXT: H     ciated with the plot (see the Gnutmeg Hdocumentation).
  2791. TEXT: H
  2792. TEXT:      A variable line looks like _n_u_m_b_e_r _n_a_m_e _t_y_p_e_n_a_m_e [ _p_a_r_m=_v_a_l_u_e
  2793. TEXT: H     ] ....  The _n_u_m_b_e_rs are irrelevant, the _n_a_m_e is the name by
  2794. TEXT: H     which this quantity will be refered to by GnutmegH, the
  2795. TEXT: H     Gtypename Hmay either a pre-defined type or one defined with
  2796. TEXT: H     the Gdeftype Hcommand, and the _p_a_r_m's are listed below.
  2797. TEXT: H                         GPredefined Types
  2798. TEXT: H
  2799. TEXT: H     HName           Description            SPICE2 Numeric Code
  2800. TEXT: H
  2801. TEXT: H     notype         Dimensionless value    0
  2802. TEXT: H     time           Time                   1
  2803. TEXT: H     frequency      Frequency              2
  2804. TEXT: H     voltage        Voltage                3
  2805. TEXT: H     Current        Current                4
  2806. TEXT: H     output-noise   SPICE2 .noise result   5
  2807. TEXT: H     input-noise    SPICE2 .noise result   6
  2808. TEXT: H     HD2            SPICE2 .disto result   7
  2809. TEXT: H     HD3            SPICE2 .disto result   8
  2810. TEXT: H     DIM2           SPICE2 .disto result   9
  2811. TEXT: H     SIM2           SPICE2 .disto result   10
  2812. TEXT: H     DIM3           SPICE2 .disto result   11
  2813. TEXT: H     pole           SPICE3 pz result       12
  2814. TEXT: H     zero           SPICE3 pz result       13
  2815. TEXT: H                                 GParameters
  2816. TEXT: H
  2817. TEXT: H     HName    Description
  2818. TEXT: H
  2819. TEXT: H     min     Minimum significant value for this output
  2820. TEXT: H     max     Maximum significant value for this output
  2821. TEXT: H     color   The name of a color to use for this value
  2822. TEXT: H     scale   The name of another output to use as the scale for this one
  2823. TEXT: H     grid    The type of grid to use - numeric codes are:
  2824. TEXT: H               0  Linear grid
  2825. TEXT: H               1  Log-log grid
  2826. TEXT: H               2  X-log/Y-linear grid
  2827. TEXT: H               3  X-linear/Y-log grid
  2828. TEXT: H               4  Polar grid
  2829. TEXT: H               5  Smith grid
  2830. TEXT: H     plot    The plotting style to use - numeric codes are:
  2831. TEXT: H               0  Connected points
  2832. TEXT: H               1  "Comb" style
  2833. TEXT: H               2  Unconnected points
  2834. TEXT: H     dims    The dimensions of this vector - not yet fully supported
  2835. TEXT: H
  2836. TEXT:      If one of the flags is _c_o_m_p_l_e_x, the points look like r,i
  2837. TEXT: H     where r and i are floating point (in %e format). Otherwise
  2838. TEXT: H     they are in %e format. Only one of _r_e_a_l and _c_o_m_p_l_e_x should
  2839. TEXT: H     appear.
  2840. TEXT: H
  2841. TEXT:      The lines are guaranteed to be less than 80 columns wide
  2842. TEXT: H     (unless the plot title or variable names are very long, or a
  2843. TEXT: H     large number of variable options are given), so this format
  2844. TEXT: H     is safe to mail between systems that enforce 80 character
  2845. TEXT: H     lines.
  2846. TEXT: H
  2847. TEXT:      The binary format is similar to the ascii format in organi-
  2848. TEXT: H     zation, except that it is not readable (strings are NULL
  2849. TEXT: H     terminated instead of newline terminated) and the values are
  2850. TEXT: H     in the machine's double precision floating point format
  2851. TEXT: H     instead of in ascii.  This makes it much easier to read and
  2852. TEXT: H     write and makes the file smaller.
  2853. TEXT: H
  2854. TEXT:      The circuit title, date, and analysis type name in that
  2855. TEXT: H     order are at the start of the plot, each terminated by a
  2856. TEXT: H     NULL byte.  Then the flags field (a _s_h_o_r_t, which is 1 for
  2857. TEXT: H     real data and 2 for complex data), the number of outputs,
  2858. TEXT: H     and the number of points (both _i_n_t_e_g_e_rs) are present.  Fol-
  2859. TEXT: H     lowing this is a list of NULL-terminated strings which are
  2860. TEXT: H     command lines.  This list is terminated by an extra NULL
  2861. TEXT: H     byte.  Then come the options, which consist of the name,
  2862. TEXT: H     followed by the type and the value in binary.  The output
  2863. TEXT: H     "declarations" consist of the name, type code, flags, color,
  2864. TEXT: H     grid type, plot type, and dimension information in that
  2865. TEXT: H     order.  Next come the values, which are either doubles or
  2866. TEXT: H     pairs of doubles in the case of complex data.
  2867. TEXT: H
  2868. TEXT:      The old format (which is used by SPICE2 with the -r option)
  2869. TEXT: H     is as follows:
  2870. TEXT: H                                 GOld
  2871. TEXT: H
  2872. TEXT: H             HField(s)          Size in Bytes
  2873. TEXT: H
  2874. TEXT: H             title             80
  2875. TEXT: H             date              8
  2876. TEXT: H             time              8
  2877. TEXT: H             numoutputs        2
  2878. TEXT: H             the integer 4     2
  2879. TEXT: H             output names      8 for each output
  2880. TEXT: H             types of output   2 for each output
  2881. TEXT: H             node index        2 for each output
  2882. TEXT: H             plot title        24
  2883. TEXT: H             data              numpoints * numoutputs * 8
  2884. TEXT: H
  2885. TEXT:      The data is in the form of double-precision numbers, or
  2886. TEXT: H     pairs of single-precision numbers if the data is complex.
  2887. TEXT: H
  2888. TEXT:      The values recognised for the "types of output" fields are
  2889. TEXT: H     described in the GPredefined Values Htable above.
  2890. TEXT: H
  2891. TEXT: GSEE ALSO
  2892. TEXT: H     Hnutmeg(1), spice(1), writedata(3)
  2893. TEXT: H
  2894. TEXT: GAUTHOR
  2895. TEXT: H     HWayne Christopher (faustus@cad.berkeley.edu)
  2896. TEXT: H
  2897. TEXT: GBUGS
  2898. TEXT: H     HIf variable names and the title and plotname strings have
  2899. TEXT: H     trailing blanks in them they will be stripped off when the
  2900. TEXT: H     file is read, if it is in ascii format.
  2901. TEXT: H
  2902. TEXT:      If a plot title begins with "Title:" Gnutmeg Hwill be fooled
  2903. TEXT: H     into thinking that this is an ascii format file. GSconvert
  2904. TEXT: H     Halways requires the type to be specified, however.
  2905. TEXT: H
  2906. TEXT:      The binary format is not well-designed and may be changed in
  2907. TEXT: H     the future.
  2908. TEXT: H
  2909. TEXT: 
  2910.  
  2911. SUBJECT: variables
  2912. TITLE: Variables
  2913. TEXT: 
  2914. TEXT:      There are many variables that have special meaning to the
  2915. TEXT: H     program.  (Note the difference between a _v_a_r_i_a_b_l_e and a _v_e_c_-
  2916. TEXT: H     _t_o_r - a _v_a_r_i_a_b_l_e is manipulated with the commands _s_e_t and
  2917. TEXT: H     _u_n_s_e_t, and may be substituted in a command line with the $
  2918. TEXT: H     notation.  A _v_e_c_t_o_r is a datum which can be plotted, manipu-
  2919. TEXT: H     lated algebraicly, and so forth.)
  2920. TEXT: H
  2921. TEXT:      A variable may also be set with the G.option Hline in the
  2922. TEXT: H     input file.  A variable set in this manner is not specific
  2923. TEXT: H     to the circuit it appears in, however.
  2924. TEXT: H
  2925. TEXT:      While any variable may be GsetH, only the following ones will
  2926. TEXT: H     have any significance to Gnutmeg Hor the simulator.  In addi-
  2927. TEXT: H     tion to those described here, all circuit variables
  2928. TEXT: H     described in the GOptions Hsection of the SPICE3 User's Guide
  2929. TEXT: H     may be set in this manner.
  2930. TEXT: H
  2931. TEXT: 
  2932. SUBTOPIC: NUTMEG:booleans NUTMEG:lists NUTMEG:numerics
  2933. SUBTOPIC: NUTMEG:plotvars NUTMEG:strings
  2934. SEEALSO: NUTMEG:set
  2935. SEEALSO: NUTMEG:unset
  2936. SEEALSO: NUTMEG:variablesub
  2937. SEEALSO: NUTMEG:options
  2938.  
  2939. SUBJECT: booleans
  2940. TITLE: Booleans
  2941. TEXT: 
  2942. TEXT:      The following variables take boolean values (either are set
  2943. TEXT: H     or aren't).
  2944. TEXT: H
  2945. TEXT: 
  2946. SUBTOPIC: NUTMEG:acct NUTMEG:appendwrite NUTMEG:cpdebug
  2947. SUBTOPIC: NUTMEG:dontplot NUTMEG:ignoreeof NUTMEG:list
  2948. SUBTOPIC: NUTMEG:noasciiplotvalue NUTMEG:noaskquit NUTMEG:nobjthack
  2949. SUBTOPIC: NUTMEG:nobreak NUTMEG:noclobber NUTMEG:node
  2950. SUBTOPIC: NUTMEG:noglob NUTMEG:nogridvar NUTMEG:nomoremode
  2951. SUBTOPIC: NUTMEG:nonomatch NUTMEG:nopage NUTMEG:noparse
  2952. SUBTOPIC: NUTMEG:noprintscale NUTMEG:nosort NUTMEG:nosubckt
  2953. SUBTOPIC: NUTMEG:opts NUTMEG:renumber NUTMEG:slowplot
  2954. SUBTOPIC: NUTMEG:strictnumparse NUTMEG:ticmarks NUTMEG:unixcom
  2955.  
  2956.  
  2957. SUBJECT: acct
  2958. TITLE: acct
  2959. TEXT: 
  2960. TEXT:      Gacct HWhen Gspice His run in batch mode, print out accounting
  2961. TEXT: H          information at the end of the run.
  2962. TEXT: H
  2963. TEXT: 
  2964. SEEALSO: NUTMEG:rusage
  2965.  
  2966. SUBJECT: appendwrite
  2967. TITLE: appendwrite
  2968. TEXT: 
  2969. TEXT:      Gappendwrite
  2970. TEXT: H          HAppend to the file when a Gwrite Hcommand is issued, if
  2971. TEXT: H          the file already exists.
  2972. TEXT: H
  2973. TEXT: 
  2974. SEEALSO: NUTMEG:write
  2975.  
  2976. SUBJECT: cpdebug
  2977. TITLE: cpdebug
  2978. TEXT: 
  2979. TEXT:      Gcpdebug
  2980. TEXT: H          HTurn on debugging in the C-shell parser.
  2981. TEXT: H
  2982. TEXT: 
  2983.  
  2984. SUBJECT: dontplot
  2985. TITLE: dontplot
  2986. TEXT: 
  2987. TEXT:      Gdontplot
  2988. TEXT: H          HWhen a Gplot Hcommand is given, don't actually do any
  2989. TEXT: H          graphics operations.  This is useful for debugging plot
  2990. TEXT: H          routines with a MFB device.
  2991. TEXT: H
  2992. TEXT: 
  2993. SEEALSO: NUTMEG:plot
  2994.  
  2995. SUBJECT: ignoreeof
  2996. TITLE: ignoreeof
  2997. TEXT: 
  2998. TEXT:      Gignoreeof
  2999. TEXT: H          HDon't exit the program when an EOF (control-D) is typed
  3000. TEXT: H          at the beginning of a line.
  3001. TEXT: H
  3002. TEXT: 
  3003.  
  3004. SUBJECT: list
  3005. TITLE: list
  3006. TEXT: 
  3007. TEXT:      Glist HWhen Gspice His run in batch mode, list the circuit
  3008. TEXT: H          before running the simulation.  This may be set with
  3009. TEXT: H          G.option list Hin the input file.
  3010. TEXT: H
  3011. TEXT: 
  3012. SEEALSO: SPICE:listing
  3013.  
  3014. SUBJECT: noasciiplotvalue
  3015. TITLE: noasciiplotvalue
  3016. TEXT: 
  3017. TEXT:      Gnoasciiplotvalue
  3018. TEXT: H          HDon't print the value of the first variable plotted
  3019. TEXT: H          with Gasciiplot Hon the left side of the graph.
  3020. TEXT: H
  3021. TEXT: 
  3022. SEEALSO: NUTMEG:asciiplot
  3023.  
  3024. SUBJECT: noaskquit
  3025. TITLE: noaskquit
  3026. TEXT: 
  3027. TEXT:      Gnoaskquit
  3028. TEXT: H          HDon't ask the user if he really wants to quit when he
  3029. TEXT: H          has simulations in progress or unsaved data.
  3030. TEXT: H
  3031. TEXT: 
  3032. SEEALSO: NUTMEG:quit
  3033.  
  3034. SUBJECT: nobjthack
  3035. TITLE: nobjthack
  3036. TEXT: 
  3037. TEXT:      Gnobjthack
  3038. TEXT: H          HDon't allow BJT's with only 3 nodes.  (This only
  3039. TEXT: H          affects subcircuit expansion.)
  3040. TEXT: H
  3041. TEXT: 
  3042.  
  3043. SUBJECT: nobreak
  3044. TITLE: nobreak
  3045. TEXT: 
  3046. TEXT:      Gnobreak
  3047. TEXT: H          HDon't add page breaks when doing an Gasciiplot Hor a
  3048. TEXT: H          Gprint colH.
  3049. TEXT: H
  3050. TEXT: 
  3051. SEEALSO: NUTMEG:asciiplot
  3052. SEEALSO: NUTMEG:print
  3053.  
  3054. SUBJECT: noclobber
  3055. TITLE: noclobber
  3056. TEXT: 
  3057. TEXT:      Gnoclobber
  3058. TEXT: H          HWhen output is redirected with >, etc, don't overwrite
  3059. TEXT: H          an existing file.
  3060. TEXT: H
  3061. TEXT: 
  3062. SEEALSO: NUTMEG:io
  3063.  
  3064. SUBJECT: node
  3065. TITLE: node
  3066. TEXT: 
  3067. TEXT:      Gnode HCauses the node table to be printed when Gspice His run
  3068. TEXT: H          in batch mode.  This is currently unimplemented.
  3069. TEXT: H
  3070. TEXT: 
  3071.  
  3072. SUBJECT: noglob
  3073. TITLE: noglob
  3074. TEXT: 
  3075. TEXT:      Gnoglob
  3076. TEXT: H          HDon't expand the characters G*H, G?H, G[H, and G] Hin an input
  3077. TEXT: H          line to match filenames.  This is generally a good idea
  3078. TEXT: H          if you want to use G* Hfor arithmetic expressions.
  3079. TEXT: H
  3080. TEXT: 
  3081. SEEALSO: NUTMEG:glob
  3082.  
  3083. SUBJECT: nogridvar
  3084. TITLE: nogrid
  3085. TEXT: 
  3086. TEXT:      Gnogrid
  3087. TEXT: H          HDon't print a grid when plotting data.  This should be
  3088. TEXT: H          a keyword for the Gplot Hcommand.
  3089. TEXT: H
  3090. TEXT: 
  3091. SEEALSO: NUTMEG:plot
  3092.  
  3093. SUBJECT: nomoremode
  3094. TITLE: nomoremode
  3095. TEXT:      nomoremode
  3096. TEXT:           When more output is generated by a single command than
  3097. TEXT:           will fit on the screen, pause and wait for the user to
  3098. TEXT:           type a carriage return.  The following commands are
  3099. TEXT:           also recognised:
  3100. TEXT: 
  3101. TEXT:              q   Discard the rest of the output.
  3102. TEXT:              c   Print the rest of the output without pausing.
  3103. TEXT:              ?   Print a help message.
  3104. TEXT: 
  3105. TEXT:           Note that setting this variable will turn off _m_o_r_e
  3106. TEXT:           _m_o_d_e, _a_n_d _a_l_l _o_u_t_p_u_t _w_i_l_l _b_e _p_r_i_n_t_e_d _w_i_t_h_o_u_t _a_n_y
  3107. TEXT:           _p_a_u_s_e_s.
  3108. TEXT: 
  3109.  
  3110. SUBJECT: nonomatch
  3111. TITLE: nonomatch
  3112. TEXT: 
  3113. TEXT:      Gnonomatch
  3114. TEXT: H          HDon't complain when a glob expression (one containing
  3115. TEXT: H          G*H, G?H, G[H, or G]H) doesn't match anything.  The unexpanded
  3116. TEXT: H          expression is left unchanged.
  3117. TEXT: H
  3118. TEXT: 
  3119. SEEALSO: NUTMEG:glob
  3120.  
  3121. SUBJECT: nopage
  3122. TITLE: nopage
  3123. TEXT: 
  3124. TEXT:      Gnopage
  3125. TEXT: H          HThis is the same as the Gnobreak Hoption.
  3126. TEXT: H
  3127. TEXT: 
  3128. SEEALSO: NUTMEG:nobreak
  3129.  
  3130. SUBJECT: noparse
  3131. TITLE: noparse
  3132. TEXT: 
  3133. TEXT:      Gnoparse
  3134. TEXT: H          HDon't parse a circuit when loading it.  The circuit
  3135. TEXT: H          cannot be simulated if it isn't parsed.
  3136. TEXT: H
  3137. TEXT: 
  3138. SEEALSO: NUTMEG:source
  3139.  
  3140. SUBJECT: noprintscale
  3141. TITLE: noprintscale
  3142. TEXT: 
  3143. TEXT:      Gnoprintscale
  3144. TEXT: H          HWhen doing a Gprint colH, don't print the scale in the
  3145. TEXT: H          leftmost column of each page.
  3146. TEXT: H
  3147. TEXT: 
  3148. SEEALSO: NUTMEG:print
  3149.  
  3150. SUBJECT: nosort
  3151. TITLE: nosort
  3152. TEXT: 
  3153. TEXT:      Gnosort
  3154. TEXT: H          HDon't sort alphabetically when doing a Gdisplay Hcommand.
  3155. TEXT: H
  3156. TEXT: 
  3157. SEEALSO: NUTMEG:display
  3158.  
  3159. SUBJECT: nosubckt
  3160. TITLE: nosubckt
  3161. TEXT: 
  3162. TEXT:      Gnosubckt
  3163. TEXT: H          HDon't expand subcircuits.  A circuit with subcircuits
  3164. TEXT: H          cannot be parsed if this is set.
  3165. TEXT: H
  3166. TEXT: 
  3167.  
  3168. SUBJECT: opts
  3169. TITLE: opts
  3170. TEXT: 
  3171. TEXT:      Gopts HWhen Gspice His run in batch mode, print out all the
  3172. TEXT: H          variables set and their values.
  3173. TEXT: H
  3174. TEXT: 
  3175. SEEALSO: NUTMEG:set
  3176. SEEALSO: NUTMEG:variables
  3177. SEEALSO: NUTMEG:batchmode
  3178.  
  3179. SUBJECT: renumber
  3180. TITLE: renumber
  3181. TEXT: 
  3182. TEXT:      Grenumber
  3183. TEXT: H          HAfter expanding subcircuits, renumber all the lines
  3184. TEXT: H          sequentially.
  3185. TEXT: H
  3186. TEXT: 
  3187. SEEALSO: SPICE:listing
  3188.  
  3189. SUBJECT: slowplot
  3190. TITLE: slowplot
  3191. TEXT: 
  3192. TEXT:      Gslowplot
  3193. TEXT: H          HPause after plotting each value and wait for the user
  3194. TEXT: H          to type a carriage return.
  3195. TEXT: H
  3196. TEXT: 
  3197. SEEALSO: NUTMEG:plot
  3198.  
  3199. SUBJECT: strictnumparse
  3200. TITLE: strictnumparse
  3201. TEXT: 
  3202. TEXT:      Gstrictnumparse
  3203. TEXT: H          HDon't allow trailing characters after a number, unless
  3204. TEXT: H          they are seperated from the number with an underscore
  3205. TEXT: H          (`_').  This may prevent some errors like writing
  3206. TEXT: H          G1meter Hand expecting it to have a value of 1.
  3207. TEXT: H
  3208. TEXT: 
  3209. SEEALSO: NUTMEG:expressions
  3210.  
  3211. SUBJECT: ticmarks
  3212. TITLE: ticmarks
  3213. TEXT: 
  3214. TEXT:      Gticmarks
  3215. TEXT: H          HPrint an 'x' every ten points for each curve plotted.
  3216. TEXT: H          This variable may also be set to a number, which is the
  3217. TEXT: H          number of points between each tic mark.
  3218. TEXT: H
  3219. TEXT: 
  3220. SEEALSO: NUTMEG:plot
  3221.  
  3222. SUBJECT: unixcom
  3223. TITLE: unixcom
  3224. TEXT: 
  3225. TEXT:      Gunixcom
  3226. TEXT: H          HIf a command is given which is not a built-in command,
  3227. TEXT: H          try to execute it as a UNIX command.  Setting this
  3228. TEXT: H          option increases the start-up time of the program a
  3229. TEXT: H          great deal, since all commands in the user's path are
  3230. TEXT: H          added to the command completion data structures, which
  3231. TEXT: H          are rather slow to update.
  3232. TEXT: H
  3233. TEXT: 
  3234. SEEALSO: NUTMEG:unixcomcomm
  3235.  
  3236. SUBJECT: lists
  3237. TITLE: Lists
  3238. TEXT: 
  3239. TEXT:      The following variables take on lists as values.  A list is
  3240. TEXT: H     surrounded by parentheses, and may contain any variable
  3241. TEXT: H     types as elements.
  3242. TEXT: H
  3243. TEXT: 
  3244. SUBTOPIC: NUTMEG:debug NUTMEG:plots NUTMEG:sourcepath
  3245.  
  3246.  
  3247. SUBJECT: debug
  3248. TITLE: debug
  3249. TEXT: 
  3250. TEXT:      Gdebug
  3251. TEXT: H          HThis variable may be a boolean, in which case all
  3252. TEXT: H          debugging is turned on, a string, in which case the
  3253. TEXT: H          string specifies which part of the program for which to
  3254. TEXT: H          turn on debugging, or a list of these strings, which
  3255. TEXT: H          turns on any combination of debuggings.  The possible
  3256. TEXT: H          values are:
  3257. TEXT: H
  3258. TEXT:              Gsiminterface   HThe interface to the simulator.
  3259. TEXT: H             Gcshpar         HThe C-shell pre-processor and parser.
  3260. TEXT: H             Gparser         HThe parser for expressions.
  3261. TEXT: H             Geval           HThe expression evaluation routines.
  3262. TEXT: H             Gvecdb          HThe vector database.
  3263. TEXT: H             Ggraf           HThe plotting routines.
  3264. TEXT: H             Gginterface     HGraphics package interface routines.
  3265. TEXT: H             Gcontrol        HThe control structure code.
  3266. TEXT: H             Gasync          HThe Gaspice Hand Grspice Hcode.
  3267. TEXT: H
  3268. TEXT: 
  3269.  
  3270. SUBJECT: plots
  3271. TITLE: plots
  3272. TEXT: 
  3273. TEXT:      Gplots
  3274. TEXT: H          HThis variable is read-only, and contains the names of
  3275. TEXT: H          the plots available.  The variable Gcurplot Hmay be set
  3276. TEXT: H          to any of these, or the word GnewH, in which case it
  3277. TEXT: H          creates a new, empty plot.
  3278. TEXT: H
  3279. TEXT: 
  3280. SEEALSO: NUTMEG:curplot
  3281.  
  3282. SUBJECT: sourcepath
  3283. TITLE: sourcepath
  3284. TEXT: 
  3285. TEXT:      Gsourcepath
  3286. TEXT: H          HThe set of directories that will be searched when a
  3287. TEXT: H          Gsource Hcommand or a command that may be the invocation
  3288. TEXT: H          of a script is given.
  3289. TEXT: H
  3290. TEXT: 
  3291. SEEALSO: NUTMEG:source
  3292.  
  3293. SUBJECT: numerics
  3294. TITLE: Numerics
  3295. TEXT: 
  3296. TEXT:      The following variables take numeric values.  No distinction
  3297. TEXT: H     is made at the user level between floating point numbers and
  3298. TEXT: H     integers.
  3299. TEXT: H
  3300. TEXT: 
  3301. SUBTOPIC: NUTMEG:abstol NUTMEG:cptime NUTMEG:fourgridsize
  3302. SUBTOPIC: NUTMEG:gridsize NUTMEG:height NUTMEG:helpxpos
  3303. SUBTOPIC: NUTMEG:helpypos NUTMEG:historyvar NUTMEG:maxwins
  3304. SUBTOPIC: NUTMEG:nfreqs NUTMEG:numdgt NUTMEG:polydegree
  3305. SUBTOPIC: NUTMEG:polysteps NUTMEG:rawfileprec NUTMEG:reltol
  3306. SUBTOPIC: NUTMEG:vntol NUTMEG:width NUTMEG:xbrushheight
  3307. SUBTOPIC: NUTMEG:xbrushwidth
  3308.  
  3309. SUBJECT: abstol
  3310. TITLE: abstol
  3311. TEXT: 
  3312. TEXT:      Gabstol
  3313. TEXT: H          HThe absolute tolerance used by the Gdiff Hcommand.  Also
  3314. TEXT: H          the Gspice Hoption described in the SPICE3 User's Guide.
  3315. TEXT: H
  3316. TEXT: 
  3317. SEEALSO: NUTMEG:diff
  3318. SEEALSO: NUTMEG:abstol
  3319.  
  3320. SUBJECT: cptime
  3321. TITLE: cptime
  3322. TEXT: 
  3323. TEXT:      Gcptime
  3324. TEXT: H          HThe total amount of CPU time to allow for a simulation.
  3325. TEXT: H
  3326. TEXT: 
  3327.  
  3328. SUBJECT: fourgridsize
  3329. TITLE: fourgridsize
  3330. TEXT: 
  3331. TEXT:      Gfourgridsize
  3332. TEXT: H          HWhen a Gfourier Hcommand is given, the data is first
  3333. TEXT: H          interpolated onto a linear grid.  The size of the grid
  3334. TEXT: H          is given by this variable.  The default is 200.
  3335. TEXT: H
  3336. TEXT: 
  3337. SEEALSO: NUTMEG:fourier
  3338.  
  3339. SUBJECT: gridsize
  3340. TITLE: gridsize
  3341. TEXT: 
  3342. TEXT:      Ggridsize
  3343. TEXT: H          HIf this variable is set, it causes all data plotted to
  3344. TEXT: H          be interpolated onto a grid of this size.  The degree
  3345. TEXT: H          of the interpolation is given by the variable Gpolyde-
  3346. TEXT: H          greeH.
  3347. TEXT: H
  3348. TEXT: 
  3349. SEEALSO: NUTMEG:plot
  3350. SEEALSO: NUTMEG:polydegree
  3351.  
  3352. SUBJECT: height
  3353. TITLE: height
  3354. TEXT: 
  3355. TEXT:      Gheight
  3356. TEXT: H          HThe height of a page to use when printing the output of
  3357. TEXT: H          Gasciiplot Hor Gprint colH.  The default is 60.
  3358. TEXT: H
  3359. TEXT: 
  3360. SEEALSO: NUTMEG:asciiplot
  3361. SEEALSO: NUTMEG:print
  3362.  
  3363. SUBJECT: helpxpos
  3364. TITLE: helpxpos
  3365. TEXT:      helpxpos
  3366. TEXT:           The starting X-position of the top-level help window.
  3367. TEXT:           The default is with the upper left corner at (100,
  3368. TEXT:           100).
  3369. TEXT: 
  3370. SEEALSO: NUTMEG:help
  3371. SEEALSO: NUTMEG:helpypos
  3372.  
  3373. SUBJECT: helpypos
  3374. TITLE: helpypos
  3375. TEXT:      helpxpos
  3376. TEXT:           The starting Y-position of the top-level help window.
  3377. TEXT:           The default is with the upper left corner at (100,
  3378. TEXT:           100).
  3379. TEXT: 
  3380. SEEALSO: NUTMEG:help
  3381. SEEALSO: NUTMEG:helpxpos
  3382.  
  3383. SUBJECT: historyvar
  3384. TITLE: history variable
  3385. TEXT: 
  3386. TEXT:      Ghistory
  3387. TEXT: H          HThe number of events to save on the history list.  The
  3388. TEXT: H          default is 1000.
  3389. TEXT: H
  3390. TEXT: 
  3391. SEEALSO: NUTMEG:historycomm
  3392. SEEALSO: NUTMEG:historyvar
  3393.  
  3394. SUBJECT: maxwins
  3395. TITLE: maxwins
  3396. TEXT: 
  3397. TEXT:      Gmaxwins
  3398. TEXT: H          HThe maximum number of X windows to create.  If this
  3399. TEXT: H          many windows are already on the screen and another is
  3400. TEXT: H          requested, the oldest one is re-used.
  3401. TEXT: H
  3402. TEXT: 
  3403. SEEALSO: NUTMEG:X
  3404. SEEALSO: NUTMEG:plot
  3405.  
  3406. SUBJECT: nfreqs
  3407. TITLE: nfreqs
  3408. TEXT: 
  3409. TEXT:      Gnfreqs
  3410. TEXT: H          HHow many multiples of the fundamental frequency to
  3411. TEXT: H          print in the Gfourier Hcommand.  The default is 10.
  3412. TEXT: H
  3413. TEXT: 
  3414. SEEALSO: NUTMEG:fourier
  3415.  
  3416. SUBJECT: numdgt
  3417. TITLE: numdgt
  3418. TEXT: 
  3419. TEXT:      Gnumdgt
  3420. TEXT: H          HHow many significant digits to print for GfourierH, Gprint
  3421. TEXT: H          colH, etc output.  The default is 6.
  3422. TEXT: H
  3423. TEXT: 
  3424. SEEALSO: NUTMEG:print
  3425. SEEALSO: NUTMEG:fourier
  3426.  
  3427. SUBJECT: polydegree
  3428. TITLE: polydegree
  3429. TEXT: 
  3430. TEXT:      Gpolydegree
  3431. TEXT: H          HThis variable determines the degree of the polynomial
  3432. TEXT: H          that is fit to points when a plot is done.  If it is
  3433. TEXT: H          not set or set to 1, then the points are connected by
  3434. TEXT: H          lines.  If it is greater than 1, then a polynomial
  3435. TEXT: H          curve is fit to the points.  If the value of Gpolydegree
  3436. TEXT: H          His _n, then for each _n + 1 adjacent points, a _nth degree
  3437. TEXT: H          curve is fit.  If this is not possible (due to the fact
  3438. TEXT: H          that the points aren't monotonic), the curve is rotated
  3439. TEXT: H          90 degrees and another attempt is made.  If is is still
  3440. TEXT: H          unsucessful, _n is decreased by 1 and the process is
  3441. TEXT: H          repeated.  Thus four points in the shape of a diamond
  3442. TEXT: H          may be fit with quadratics to approximate a circle.
  3443. TEXT: H          (Although it's not clear that this situation comes up
  3444. TEXT: H          often in circuit simulation.)  The variable Ggridsize
  3445. TEXT: H          Hdetermines the size of the grid on which the curve is
  3446. TEXT: H          fit (if the data is monotonic).
  3447. TEXT: H
  3448. TEXT: 
  3449. SEEALSO: NUTMEG:plot
  3450.  
  3451. SUBJECT: polysteps
  3452. TITLE: polysteps
  3453. TEXT: 
  3454. TEXT:      Gpolysteps
  3455. TEXT: H          HThe number of intermediate points to plot between each
  3456. TEXT: H          actual point used for interpolation.  The default is
  3457. TEXT: H          10.  Note that if interpolation is used for plotting,
  3458. TEXT: H          the Gticmarks Hfeature is disabled.
  3459. TEXT: H
  3460. TEXT: 
  3461. SEEALSO: NUTMEG:plot
  3462.  
  3463. SUBJECT: rawfileprec
  3464. TITLE: rawfileprec
  3465. TEXT: 
  3466. TEXT:      Grawfileprec
  3467. TEXT: H          HThe number of digits to use in the ascii rawfile for-
  3468. TEXT: H          mat.  The default is 15, which should be enough.
  3469. TEXT: H
  3470. TEXT: 
  3471. SEEALSO: NUTMEG:write
  3472.  
  3473. SUBJECT: reltol
  3474. TITLE: reltol
  3475. TEXT: 
  3476. TEXT:      Greltol
  3477. TEXT: H          HThe relative tolerance used by the Gdiff Hcommand.  See
  3478. TEXT: H          the SPICE3 User's Guide.
  3479. TEXT: H
  3480. TEXT: 
  3481. SEEALSO: NUTMEG:diff
  3482. SEEALSO: NUTMEG:reltol
  3483.  
  3484. SUBJECT: vntol
  3485. TITLE: vntol
  3486. TEXT: 
  3487. TEXT:      Gvntol
  3488. TEXT: H          HThe absolute voltage tolerance used for the Gdiff Hcom-
  3489. TEXT: H          mand.  See the SPICE3 User's Guide.
  3490. TEXT: H
  3491. TEXT: 
  3492. SEEALSO: NUTMEG:diff
  3493. SEEALSO: NUTMEG:vntol
  3494.  
  3495. SUBJECT: width
  3496. TITLE: width
  3497. TEXT: 
  3498. TEXT:      Gwidth
  3499. TEXT: H          HThe width of a page to use when printing the output of
  3500. TEXT: H          Gasciiplot Hor Gprint colH.  The default is 130.
  3501. TEXT: H
  3502. TEXT: 
  3503. SEEALSO: NUTMEG:print
  3504. SEEALSO: NUTMEG:asciiplot
  3505.  
  3506. SUBJECT: xbrushheight
  3507. TITLE: xbrushheight
  3508. TEXT: 
  3509. TEXT:      Gxbrushheight
  3510. TEXT: H          HThe height of the "brush" used by X to plot data.  The
  3511. TEXT: H          default is 1.
  3512. TEXT: H
  3513. TEXT: 
  3514. SEEALSO: NUTMEG:X
  3515. SEEALSO: NUTMEG:plot
  3516.  
  3517. SUBJECT: xbrushwidth
  3518. TITLE: xbrushwidth
  3519. TEXT: 
  3520. TEXT:      Gxbrushwidth
  3521. TEXT: H          HThe width of the "brush" used by X to plot data.  The
  3522. TEXT: H          default is 1.
  3523. TEXT: H
  3524. TEXT: 
  3525. SEEALSO: NUTMEG:plot
  3526. SEEALSO: NUTMEG:X
  3527.  
  3528. SUBJECT: plotvars
  3529. TITLE: Plot-specific Variables
  3530. TEXT: 
  3531. TEXT:      The following variables are specific to each plot.  When the
  3532. TEXT: H     current plot changes, these variables take on new values,
  3533. TEXT: H     and they cannot be altered by the user.  In addition to
  3534. TEXT: H     these variables, any variables defined in the rawfile on a
  3535. TEXT: H     GOption: Hline are associated with the plot and are read-only,
  3536. TEXT: H     but variables defined by a GCommand: set ... Hline are not.
  3537. TEXT: H
  3538. TEXT: 
  3539. SUBTOPIC: NUTMEG:curplot NUTMEG:curplotdate NUTMEG:curplotname
  3540. SUBTOPIC: NUTMEG:curplottitle
  3541.  
  3542. SUBJECT: curplot
  3543. TITLE: curplot
  3544. TEXT: 
  3545. TEXT:      Gcurplot
  3546. TEXT: H          HThe name of the currently active plot.
  3547. TEXT: H
  3548. TEXT: 
  3549. SEEALSO: NUTMEG:plots
  3550. SEEALSO: NUTMEG:setplot
  3551.  
  3552. SUBJECT: curplotdate
  3553. TITLE: curplotdate
  3554. TEXT: 
  3555. TEXT:      Gcurplotdate
  3556. TEXT: H          HThe date associated with the currently active plot.
  3557. TEXT: H          This is generally the date of the simulation.
  3558. TEXT: H
  3559. TEXT: 
  3560.  
  3561. SUBJECT: curplotname
  3562. TITLE: curplotname
  3563. TEXT: 
  3564. TEXT:      Gcurplotname
  3565. TEXT: H          HThe type name of the currently active plot.  Note that
  3566. TEXT: H          this is Gnot Hthe name used by GsetplotH, but rather an
  3567. TEXT: H          English description of the type of simulation done.
  3568. TEXT: H
  3569. TEXT: 
  3570.  
  3571. SUBJECT: curplottitle
  3572. TITLE: curplottitle
  3573. TEXT: 
  3574. TEXT:      Gcurplottitle
  3575. TEXT: H          HThe title of the circuit associated with the currently
  3576. TEXT: H          active plot.
  3577. TEXT: H
  3578. TEXT: 
  3579.  
  3580. SUBJECT: strings
  3581. TITLE: Strings
  3582. TEXT: 
  3583. TEXT:      These variables take on strings as values.
  3584. TEXT: H
  3585. TEXT: 
  3586. SUBTOPIC: NUTMEG:color NUTMEG:device NUTMEG:xdisplay
  3587. SUBTOPIC: SPICE:editor NUTMEG:filetype NUTMEG:geometry
  3588. SUBTOPIC: NUTMEG:gridstyle NUTMEG:hbfont NUTMEG:hbstyle
  3589. SUBTOPIC: NUTMEG:hcopydev NUTMEG:helpboldfont NUTMEG:helpitalicfont
  3590. SUBTOPIC: NUTMEG:helpregfont NUTMEG:helptitlefont NUTMEG:modelcard
  3591. SUBTOPIC: NUTMEG:plotstyle NUTMEG:pointchars NUTMEG:program
  3592. SUBTOPIC: NUTMEG:prompt NUTMEG:rawfile NUTMEG:rhost
  3593. SUBTOPIC: NUTMEG:rprogram NUTMEG:spicepath NUTMEG:subend
  3594. SUBTOPIC: NUTMEG:subinvoke NUTMEG:substart NUTMEG:term
  3595. SUBTOPIC: NUTMEG:units NUTMEG:xfont
  3596.  
  3597. SUBJECT: color
  3598. TITLE: color
  3599. TEXT: 
  3600. TEXT:      GcolorH_n_u_m_b_e_r
  3601. TEXT: H          If a variable with the name GcolorH_n_u_m_b_e_r is set to the
  3602. TEXT: H          name of a color recognised by X (see the file
  3603. TEXT: H          G/usr/lib/rgb.txt Hfor a list of such colors), the
  3604. TEXT: H          _n_u_m_b_e_r'th value plotted in a window will have this
  3605. TEXT: H          color.  Gcolor0 Hdenotes the background color and Gcolor1
  3606. TEXT: H          Hdenotes the grid and text color.
  3607. TEXT: H
  3608. TEXT: 
  3609. SEEALSO: NUTMEG:X
  3610. SEEALSO: NUTMEG:plot
  3611.  
  3612. SUBJECT: device
  3613. TITLE: device
  3614. TEXT: 
  3615. TEXT:      Gdevice
  3616. TEXT: H          HThe path name of the graphics device for MFB to use for
  3617. TEXT: H          plotting, or the display name for X to use.
  3618. TEXT: H
  3619. TEXT: 
  3620. SEEALSO: NUTMEG:plot
  3621.  
  3622. SUBJECT: xdisplay
  3623. TITLE: display
  3624. TEXT: 
  3625. TEXT:      Gdisplay
  3626. TEXT: H          HThe display name for X to use for plotting, generally
  3627. TEXT: H          of the form _h_o_s_t:_n_u_m_b_e_r.
  3628. TEXT: H
  3629. TEXT: 
  3630. SEEALSO: NUTMEG:X
  3631. SEEALSO: NUTMEG:plot
  3632.  
  3633. SUBJECT: filetype
  3634. TITLE: filetype
  3635. TEXT: 
  3636. TEXT:      Gfiletype
  3637. TEXT: H          HThe type of rawfile that the Gwrite Hcommand should
  3638. TEXT: H          create.  Currently the only types supported are Gascii
  3639. TEXT: H          Hand GbinaryH.
  3640. TEXT: H
  3641. TEXT: 
  3642. SEEALSO: NUTMEG:write
  3643.  
  3644. SUBJECT: geometry
  3645. TITLE: geometry
  3646. TEXT: 
  3647. TEXT:      Ggeometry
  3648. TEXT: H          HThe X geometry specification to use for creating win-
  3649. TEXT: H          dows.  This is of the form
  3650. TEXT: H          G=H_h_e_i_g_h_tGxH_w_i_d_t_hG+H_x_o_f_f_s_e_tG+H_y_o_f_f_s_e_t.  Note that the G= Hmust be
  3651. TEXT: H          included in the string.  Also, variables of the form
  3652. TEXT: H          GgeometryH_n_u_m_b_e_r may be set, which determine the geometry
  3653. TEXT: H          to use for the _n_u_m_b_e_rth window created.
  3654. TEXT: H
  3655. TEXT: 
  3656. SEEALSO: NUTMEG:X
  3657. SEEALSO: NUTMEG:plot
  3658.  
  3659. SUBJECT: gridstyle
  3660. TITLE: gridstyle
  3661. TEXT:      gridstyle
  3662. TEXT:           This variable is used to determine the style of grid
  3663. TEXT:           used by the commands plot, hardcopy, and asciiplot, if
  3664. TEXT:           no grid style keywords are given on the command line.
  3665. TEXT:           Possible values are:
  3666. TEXT:     lingrid   Use a linear grid
  3667. TEXT:     loglog    Use a log scales for both axes
  3668. TEXT:     xlog      Use a log scale for the X axis
  3669. TEXT:     ylog      Use a log scale for the Y axis
  3670. TEXT:     nogrid    Don't draw any grid (but draw the data on a linear scale)
  3671. TEXT: 
  3672. SEEALSO: NUTMEG:plot
  3673.  
  3674. SUBJECT: hbfont
  3675. TITLE: helpbuttonfont
  3676. TEXT:      helpbuttonfont
  3677. TEXT:           The name of the X font to use for the labels in the
  3678. TEXT:           buttons in the help system.  The default is "6x10".
  3679. TEXT: 
  3680.  
  3681. SUBJECT: hbstyle
  3682. TITLE: helpbuttonstyle
  3683. TEXT:      helpbuttonstyle
  3684. TEXT:           This option controls the style of layout that the help
  3685. TEXT:           system will use for formatting sub-topic and see-also
  3686. TEXT:           buttons.  If it is left, buttons in a column will be
  3687. TEXT:           aligned on their left sides.  If it is center, columns
  3688. TEXT:           of buttons will be centered around their midlines.  If
  3689. TEXT:           it is unif, buttons in a column will all be the same
  3690. TEXT:           size and the text will be centered within each button.
  3691. TEXT:           The default is left.
  3692. TEXT: 
  3693. SEEALSO: NUTMEG:help
  3694.  
  3695. SUBJECT: hcopydev
  3696. TITLE: hcopydev
  3697. TEXT: 
  3698. TEXT:      Ghcopydev
  3699. TEXT: H          HIf this variable is set to the name of a printer (the
  3700. TEXT: H          name used in the G-P Hoption to GlprH), it directs the
  3701. TEXT: H          Ghardcopy Hcommand to immediately send the raster file to
  3702. TEXT: H          this printer.  This works only on UNIX.
  3703. TEXT: H
  3704. TEXT: 
  3705. SEEALSO: NUTMEG:hardcopy
  3706.  
  3707. SUBJECT: helpboldfont
  3708. TITLE: helpboldfont
  3709. TEXT:      helpboldfont
  3710. TEXT:           The name of the X font to use for bold characters in
  3711. TEXT:           the help system.  The default is "timrom12b".   Note
  3712. TEXT:           that this font should have the same height as the regu-
  3713. TEXT:           lar and italic fonts.
  3714. TEXT: 
  3715.  
  3716. SUBJECT: helpitalicfont
  3717. TITLE: helpitalicfont
  3718. TEXT:      helpitalicfont
  3719. TEXT:           The name of the X font to use for italic characters in
  3720. TEXT:           the help system.  The default is "timrom12i".   Note
  3721. TEXT:           that this font should have the same height as the regu-
  3722. TEXT:           lar and bold fonts.
  3723. TEXT: 
  3724.  
  3725. SUBJECT: helpregfont
  3726. TITLE: helpregfont
  3727. TEXT:      helpregfont
  3728. TEXT:           The name of the X font to use for regular characters in
  3729. TEXT:           the help system.  The default is "timrom12".   Note
  3730. TEXT:           that this font should have the same height as the bold
  3731. TEXT:           and italic fonts.
  3732. TEXT: 
  3733.  
  3734. SUBJECT: helptitlefont
  3735. TITLE: helptitlefont
  3736. TEXT:      helptitlefont
  3737. TEXT:           The name of the X font to use for titles in the help
  3738. TEXT:           system.  The default is "accordb".
  3739. TEXT: 
  3740.  
  3741. SUBJECT: modelcard
  3742. TITLE: modelcard
  3743. TEXT: 
  3744. TEXT:      Gmodelcard
  3745. TEXT: H          HThe name of the line used to introduce a model, gen-
  3746. TEXT: H          erally G.modelH.
  3747. TEXT: H
  3748. TEXT: 
  3749.  
  3750. SUBJECT: plotstyle
  3751. TITLE: plotstyle
  3752. TEXT:      plotstyle
  3753. TEXT:           This variable is used to determine the plot style if no
  3754. TEXT:           plotstyle keyword is given on the command line for the
  3755. TEXT:           commands plot, hardcopy, and asciiplot.  Its value may
  3756. TEXT:           be one of:
  3757. TEXT:             linplot     Connect points with line segments
  3758. TEXT:             combplot    Connect each point to the X-axis
  3759. TEXT:             pointplot   Plot each point as a discrete character
  3760. TEXT: 
  3761. SEEALSO: NUTMEG:plot
  3762.  
  3763. SUBJECT: pointchars
  3764. TITLE: pointchars
  3765. TEXT: 
  3766. TEXT:      Gpointchars
  3767. TEXT: H          HThe characters in this string are used to plot suces-
  3768. TEXT: H          sive data values if the Gpointplot Hkeyword is given in a
  3769. TEXT: H          Gplot Hcommand.  The default is
  3770. TEXT: H          "oxabcdefhgijklmnpqrstuvwyz".
  3771. TEXT: H
  3772. TEXT: 
  3773. SEEALSO: NUTMEG:plot
  3774.  
  3775. SUBJECT: program
  3776. TITLE: program
  3777. TEXT: 
  3778. TEXT:      Gprogram
  3779. TEXT: H          HThe full path name of the current program.
  3780. TEXT: H
  3781. TEXT: 
  3782.  
  3783. SUBJECT: prompt
  3784. TITLE: prompt
  3785. TEXT: 
  3786. TEXT:      Gprompt
  3787. TEXT: H          HThe prompt that the command interpreter should use.  In
  3788. TEXT: H          this string, the character `!' is replaced by the
  3789. TEXT: H          current command number.  If the program is reading
  3790. TEXT: H          lines which form a part of a control block, the prompt
  3791. TEXT: H          becomes a set of `>' characters, one for each level of
  3792. TEXT: H          control structure.  The default prompt is "G$H_p_r_o_g_r_a_m G!
  3793. TEXT: H          -> H".
  3794. TEXT: H
  3795. TEXT: 
  3796.  
  3797. SUBJECT: rawfile
  3798. TITLE: rawfile
  3799. TEXT: 
  3800. TEXT:      Grawfile
  3801. TEXT: H          HThe name of the rawfile to use as a default for the
  3802. TEXT: H          Gwrite Hcommand, or for batch mode.
  3803. TEXT: H
  3804. TEXT: 
  3805. SEEALSO: NUTMEG:write
  3806. SEEALSO: NUTMEG:load
  3807.  
  3808. SUBJECT: rhost
  3809. TITLE: rhost
  3810. TEXT: 
  3811. TEXT:      Grhost
  3812. TEXT: H          HThe name of the machine to run remote simulations on.
  3813. TEXT: H          This machine must have a spice daemon running.
  3814. TEXT: H
  3815. TEXT: 
  3816. SEEALSO: SPICE:rspice
  3817.  
  3818. SUBJECT: rprogram
  3819. TITLE: rprogram
  3820. TEXT: 
  3821. TEXT:      Grprogram
  3822. TEXT: H          HThe name of the program to run when an Grspice Hcommand
  3823. TEXT: H          is given.
  3824. TEXT: H
  3825. TEXT: 
  3826. SEEALSO: SPICE:rspice
  3827.  
  3828. SUBJECT: spicepath
  3829. TITLE: spicepath
  3830. TEXT: 
  3831. TEXT:      Gspicepath
  3832. TEXT: H          HThe filename to execute when an Gaspice Hcommand is
  3833. TEXT: H          given.
  3834. TEXT: H
  3835. TEXT: 
  3836. SEEALSO: SPICE:aspice
  3837.  
  3838. SUBJECT: subend
  3839. TITLE: subend
  3840. TEXT: 
  3841. TEXT:      Gsubend
  3842. TEXT: H          HThe name of the subcircuit-ending line, generally
  3843. TEXT: H          G.endsH.
  3844. TEXT: H
  3845. TEXT: 
  3846.  
  3847. SUBJECT: subinvoke
  3848. TITLE: subinvoke
  3849. TEXT: 
  3850. TEXT:      Gsubinvoke
  3851. TEXT: H          HThe prefix used to call up an instance of a subcircuit,
  3852. TEXT: H          generally "GxH".
  3853. TEXT: H
  3854. TEXT: 
  3855.  
  3856. SUBJECT: substart
  3857. TITLE: substart
  3858. TEXT: 
  3859. TEXT:      Gsubstart
  3860. TEXT: H          HThe name of the line used to start a subcircuit defini-
  3861. TEXT: H          tion, generally
  3862. TEXT: H
  3863. TEXT: 
  3864.  
  3865. SUBJECT: term
  3866. TITLE: term
  3867. TEXT: 
  3868. TEXT:      Gterm HThe name of the terminal type for MFB.  Note that these
  3869. TEXT: H          names are often not the same as the ones that _t_e_r_m_c_a_p
  3870. TEXT: H          recognises, so the value of the environment variable
  3871. TEXT: H          TERM may not work (but it will be used if this variable
  3872. TEXT: H          is not set).  See the beginning of the file
  3873. TEXT: H          "spice3/lib/mfbcap" for descriptions of the terminals
  3874. TEXT: H          supported.
  3875. TEXT: H
  3876. TEXT: 
  3877. SEEALSO: NUTMEG:plot
  3878.  
  3879. SUBJECT: units
  3880. TITLE: units
  3881. TEXT: 
  3882. TEXT:      Gunits
  3883. TEXT: H          HIf this variable is set to GdegreesH, all trig functions
  3884. TEXT: H          will use degrees instead of radians for the units of
  3885. TEXT: H          their arguments.
  3886. TEXT: H
  3887. TEXT: 
  3888. SEEALSO: NUTMEG:sin
  3889. SEEALSO: NUTMEG:cos
  3890. SEEALSO: NUTMEG:tan
  3891.  
  3892. SUBJECT: xfont
  3893. TITLE: xfont
  3894. TEXT: 
  3895. TEXT:      Gxfont
  3896. TEXT: H          HThe name of the font to use in an X window.  This may
  3897. TEXT: H          be a proportional font.
  3898. TEXT: H
  3899. TEXT: 
  3900. SEEALSO: NUTMEG:X
  3901. SEEALSO: NUTMEG:plot
  3902.  
  3903. SUBJECT: vms
  3904. TITLE: VAX-VMS Notes
  3905. TEXT: 
  3906. TEXT:      GNutmeg Hcan be run under VAX/VMS. Some features like command,
  3907. TEXT: H     etc completion, expansion of `*', `?', and [], backquote
  3908. TEXT: H     substitution, the shell command, and so forth do not work.
  3909. TEXT: H
  3910. TEXT:      GNutmeg Hwill look for start-up commands in the file _s_p_i_c_e._r_c
  3911. TEXT: H     in the current directory.
  3912. TEXT: H
  3913. TEXT:      The standard suffix for rawspice files in VMS is ".raw".
  3914. TEXT: H
  3915. TEXT:      You will have to respond to the -_m_o_r_e- prompt during Gplot
  3916. TEXT: H     Hwith a carriage return instead of any key as you can do with
  3917. TEXT: H     UNIX.
  3918. TEXT: H
  3919. TEXT: 
  3920.  
  3921.